Shard

A shard created within a Conduit.

Constructors

1
new Shard(conduit: Conduit, data: ConduitShardData & object): Shard

Builds up a Shard.

Parameter	Type	Description
`conduit`	`Conduit`	The Conduit that created this shard.
`data`	`ConduitShardData` & `object`	The data from the API. If the shard is of type ‘webhook’, it aditionally includes the secret which is not returned by the API.

Property	Modifier	Type	Description
`callback?`	`readonly`	`string`	The callback of the shard. Only present in webhook type.
`conduit`	`readonly`	`Conduit`	The Conduit that created this shard.
`id`	`readonly`	`string`	The id of the shard. Starting from 0.
`secret?`	`readonly`	`string`	The secret of the shard. Only present in webhook type.
`sessionId?`	`readonly`	`string`	The session id of the shard. Only present in websocket type.
`status`	`readonly`	`string`	The status of the shard. Probably ‘enabled’.
`type`	`readonly`	`"websocket"` \| `"webhook"`	The type of transport of the shard.

1
delete(): Promise<Shard[]>

Deletes the shard.

Promise<Shard[]>

1
toAPI(): object

Converts the shard to the API format.

object

The shard into API format.