Runta
Configure the TypeScript SDK client and access runtime, secret, and checkpoint operations.
Runta declaration
Section titled “Runta declaration”class RuntaRunta construction
Section titled “Runta construction”new Runta(config: RuntaConfig = {}): RuntaParameters
Section titled “Parameters”| Name | Type | Default | Description |
|---|---|---|---|
config |
RuntaConfig |
{} |
Client or secret-injection configuration. |
Returns
Section titled “Returns”Runta
Runta properties
Section titled “Runta properties”| Name | Type | Description |
|---|---|---|
endpoint |
string |
Resolved Runta API endpoint. |
token |
string |
Bearer token used for authentication. |
checkpoints |
CheckpointManager |
Tenant checkpoint lookup and deletion operations. |
runtimes |
RuntimeManager |
Runtime creation, lookup, and listing operations. |
secrets |
SecretManager |
Tenant secret and default secret-stub operations. |
Runta methods
Section titled “Runta methods”close()
Section titled “close()”Release resources held by the client.
Runta.close(): Promise<void>Returns
Section titled “Returns”Promise<void>
health()
Section titled “health()”Return whether the Runta API is reachable.
Runta.health(): Promise<boolean>Returns
Section titled “Returns”Promise<boolean>
Examples
Section titled “Examples”const client = new Runta();if (!(await client.health())) throw new Error("Runta API is unavailable");Runta compatibility aliases
Section titled “Runta compatibility aliases”AsyncRuntaextendsRuntafor cross-SDK naming compatibility. All TypeScript operations already return promises; useRuntafor new code.
