Namespaces
version
Methods and types of the `version` namespace (`client.version` / `bot.version`).
Interfaces
CommitResponse
Properties
HealthStatus
Indexable
[key: string]: unknownProperties
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
| Parameter | Type | Description |
|---|---|---|
client | default | The NuramaClient instance. |
Returns
An object containing the version-related methods.
| Name | Type | Description |
|---|---|---|
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. |