Class StatusResource

Shard status, health, roster, and embed endpoints.

Index

Constructors

Methods

get getEmbedStatus getEmbedWidget getHealth getOpenApi getRoster

Constructors

constructor

new StatusResource(http: BaseClient): StatusResource
Parameters
- http: BaseClient
Returns StatusResource
- Defined in src/resources/status.ts:16

Methods

get

get(): Promise<ShardStatusResponse>
Fetches live net status, occupancy, and feature config from the shard.

Returns Promise<ShardStatusResponse>
- Defined in src/resources/status.ts:50

getEmbedStatus

getEmbedStatus(token: string): Promise<ShardEmbedStatusResponse>
Fetches embed status for a public token.
Parameters
- token: string
  Public embed token issued by the shard.
Returns Promise<ShardEmbedStatusResponse>
- Defined in src/resources/status.ts:34

getEmbedWidget

getEmbedWidget(token: string): Promise<string>
Fetches the embeddable HTML widget for a public token.
Parameters
- token: string
  Public embed token issued by the shard.
Returns Promise<string>
Raw HTML string of the widget.
- Defined in src/resources/status.ts:45

getHealth

getHealth(): Promise<ShardHealthResponse>
Checks shard liveness. Unauthenticated.

Returns Promise<ShardHealthResponse>
- Defined in src/resources/status.ts:21

getOpenApi

getOpenApi(): Promise<ShardOpenApiResponse>
Fetches the shard's OpenAPI specification document. Unauthenticated.

Returns Promise<ShardOpenApiResponse>
- Defined in src/resources/status.ts:26

getRoster

getRoster(): Promise<ShardRosterResponse>
Fetches the full operator roster with transport and transmission state.

Returns Promise<ShardRosterResponse>
- Defined in src/resources/status.ts:55