Nurama Developers
Namespaces

version

Methods and types of the `version` namespace (`client.version` / `bot.version`).

Interfaces

CommitResponse

Properties

PropertyType
buildCommitstring

HealthStatus

Indexable

[key: string]: unknown

Properties

PropertyTypeDescription
memoryRecord<string, unknown>-
postgres{ [key: string]: unknown; status: "connected" | "disconnected"; }-
postgres.status"connected" | "disconnected"-
reason?stringPresent when status is degraded or unhealthy.
status"healthy" | "degraded" | "unhealthy"-
timestampnumberEpoch milliseconds when the check ran.
uptimenumberProcess uptime in seconds.

Type Aliases

VersionMethods

type VersionMethods = ReturnType<typeof default>;

Functions

default()

function default(client): {
  getCommitHash: Promise<CommitResponse>;
  getHealth: Promise<HealthStatus>;
};

Defines version-related methods for the NuramaClient.

Parameters

ParameterTypeDescription
clientdefaultThe NuramaClient instance.

Returns

An object containing the version-related methods.

NameTypeDescription
getCommitHash()() => Promise<CommitResponse>Retrieves the latest git commit hash of the deployed application. This is a public endpoint and does not require authentication.
getHealth()() => Promise<HealthStatus>Retrieves the API health report (database connectivity, memory, uptime). Public endpoint. Resolves normally for healthy and degraded; the API responds 503 for unhealthy, which surfaces as a thrown error with status: 503 and the report on data.

On this page