Class WorkerClient<Ready>

Type Parameters

Ready extends boolean = boolean

Hierarchy

BaseClient
- WorkerClient

Constructors

constructor

new WorkerClient<Ready extends boolean = boolean>(
options?: WorkerClientOptions,
): WorkerClient<Ready>
Type Parameters
- Ready extends boolean = boolean
Parameters
- Optionaloptions: WorkerClientOptions
Returns WorkerClient<Ready>
Overrides BaseClient.constructor
- Defined in src/client/workerclient.ts:81

Properties

applications

applications: ApplicationShorter = ...

bans

bans: BanShorter = ...

cache

cache: Cache = ...

channels

channels: ChannelShorter = ...

collectors

collectors: Collectors = ...

commands

commands: CommandHandler = ...

components

components: ComponentHandler = ...

`Optional`debugger

debugger?: Logger

emojis

emojis: EmojiShorter = ...

events

events: EventHandler = ...

guilds

guilds: GuildShorter = ...

handleCommand

handleCommand: HandleCommand

interactions

interactions: InteractionShorter = ...

invites

invites: InvitesShorter = ...

langs

langs: LangsHandler = ...

logger

logger: Logger = ...

me

me: When<Ready, ClientUser>

members

members: MemberShorter = ...

memberUpdateHandler

memberUpdateHandler: MemberUpdateHandler = ...

messages

messages: MessageShorter = ...

`Optional`middlewares

middlewares?: Record<string, MiddlewareContext>

options

options: WorkerClientOptions

presenceUpdateHandler

presenceUpdateHandler: PresenceUpdateHandler = ...

promises

promises: Map<string, { resolve: (value: any) => void; timeout: Timeout }> = ...

reactions

reactions: ReactionShorter = ...

resharding

resharding: Map<number, Shard> = ...

rest

rest: ApiHandler = ...

roles

roles: RoleShorter = ...

shards

shards: Map<number, Shard> = ...

soundboards

soundboards: SoundboardShorter = ...

templates

templates: TemplateShorter = ...

threads

threads: ThreadShorter = ...

users

users: UsersShorter = ...

voiceStates

voiceStates: VoiceStateShorter = ...

webhooks

webhooks: WebhookShorter = ...

Accessors

applicationId

get applicationId(): string
Returns string
Overrides BaseClient.applicationId
- Defined in src/client/workerclient.ts:108
set applicationId(id: string): void
Parameters
- id: string
Returns void
Overrides BaseClient.applicationId
- Defined in src/client/workerclient.ts:112

botId

get botId(): string
Returns string
Inherited from BaseClient.botId
- Defined in src/client/base.ts:182
set botId(id: string): void
Parameters
- id: string
Returns void
Inherited from BaseClient.botId
- Defined in src/client/base.ts:178

latency

get latency(): number
Returns number
- Defined in src/client/workerclient.ts:100

proxy

get proxy(): APIRoutes
Returns APIRoutes
Inherited from BaseClient.proxy
- Defined in src/client/base.ts:174

workerData

get workerData(): WorkerData
Returns WorkerData
- Defined in src/client/workerclient.ts:127

workerId

get workerId(): number
Returns number
- Defined in src/client/workerclient.ts:96

Methods

calculateShardId

calculateShardId(guildId: string): number
Parameters
- guildId: string
Returns number
- Defined in src/client/workerclient.ts:403

createShard

createShard(
id: number,
data: Pick<ManagerSpawnShards, "info" | "compress" | "properties">,
): Shard
Parameters
- id: number
- data: Pick<ManagerSpawnShards, "info" | "compress" | "properties">
Returns Shard
- Defined in src/client/workerclient.ts:444

`Protected`execute

execute(..._options: unknown[]): Promise<void>
Parameters
- ..._options: unknown[]
Returns Promise<void>
Inherited from BaseClient.execute
- Defined in src/client/base.ts:245

getRC

getRC<
    T extends
        InternalRuntimeConfigHTTP
        | InternalRuntimeConfig =
        | InternalRuntimeConfigHTTP
        | InternalRuntimeConfig,
>(): Promise<
    { debug: boolean } & Omit<T, "debug" | "locations"> & {
        locations: RCLocations;
    },
>
Type Parameters
- T extends InternalRuntimeConfigHTTP | InternalRuntimeConfig = InternalRuntimeConfigHTTP | InternalRuntimeConfig
Returns Promise<
    { debug: boolean } & Omit<T, "debug" | "locations"> & {
        locations: RCLocations;
    },
>
Inherited from BaseClient.getRC
- Defined in src/client/base.ts:418

handleManagerMessages

handleManagerMessages(data: ManagerMessages | SendHeartbeat): Promise<any>
Parameters
- data: ManagerMessages | SendHeartbeat
Returns Promise<any>
- Defined in src/client/workerclient.ts:183

loadCommands

loadCommands(dir?: string): Promise<void>
Parameters
- Optionaldir: string
Returns Promise<void>
Inherited from BaseClient.loadCommands
- Defined in src/client/base.ts:390

loadComponents

loadComponents(dir?: string): Promise<void>
Parameters
- Optionaldir: string
Returns Promise<void>
Inherited from BaseClient.loadComponents
- Defined in src/client/base.ts:398

loadEvents

loadEvents(dir?: string): Promise<void>
Parameters
- Optionaldir: string
Returns Promise<void>
- Defined in src/client/workerclient.ts:170

loadLangs

loadLangs(dir?: string): Promise<void>
Parameters
- Optionaldir: string
Returns Promise<void>
Inherited from BaseClient.loadLangs
- Defined in src/client/base.ts:406

onInteractionRequest

onInteractionRequest(
    rawBody: APIInteraction,
): Promise<
    {
        headers: { "Content-Type"?: string };
        response: APIInteractionResponse | FormData;
    },
>
Parameters
- rawBody: APIInteraction
  body of interaction
Returns Promise<
    {
        headers: { "Content-Type"?: string };
        response: APIInteractionResponse | FormData;
    },
>
Inherited from BaseClient.onInteractionRequest
- Defined in src/client/base.ts:287

`Protected`onPacket

onPacket(packet: GatewayDispatchPayload, shardId: number): Promise<void>
Parameters
- packet: GatewayDispatchPayload
- shardId: number
Returns Promise<void>
Overrides BaseClient.onPacket
- Defined in src/client/workerclient.ts:495

postMessage

postMessage(body: WorkerMessages): unknown
Parameters
- body: WorkerMessages
Returns unknown
- Defined in src/client/workerclient.ts:178

resumeShard

resumeShard(
shardId: number,
shardData: MakeRequired<ShardData>,
): Promise<unknown>
Parameters
- shardId: number
- shardData: MakeRequired<ShardData>
Returns Promise<unknown>
- Defined in src/client/workerclient.ts:475

setServices

setServices(rest: ServicesOptions): void
Parameters
- rest: ServicesOptions
Returns void
Overrides BaseClient.setServices
- Defined in src/client/workerclient.ts:116

setWorkerData

setWorkerData(data: WorkerData): void
Parameters
- data: WorkerData
Returns void
- Defined in src/client/workerclient.ts:123

start

start(
    options?: Omit<
        DeepPartial<StartOptions>,
        "httpConnection" | "token" | "connection",
    >,
): Promise<void>
Parameters
- options: Omit<DeepPartial<StartOptions>, "httpConnection" | "token" | "connection"> = {}
Returns Promise<void>
Overrides BaseClient.start
- Defined in src/client/workerclient.ts:131

t

t(
locale: string,
): __InternalParseLocale<DefaultLocale> & {
get(locale?: string): DefaultLocale;
}
Parameters
- locale: string
Returns __InternalParseLocale<DefaultLocale> & { get(locale?: string): DefaultLocale }
Inherited from BaseClient.t
- Defined in src/client/base.ts:414

tellWorker

tellWorker<R, V extends Record<string, unknown>>(
    workerId: number,
    func: (_: this, vars: V) => R,
    vars: V,
): Promise<R>
Type Parameters
- R
- V extends Record<string, unknown>
Parameters
- workerId: number
- func: (_: this, vars: V) => R
- vars: V
Returns Promise<R>
- Defined in src/client/workerclient.ts:423

tellWorkers

tellWorkers<R, V extends Record<string, unknown>>(
func: (_: this, vars: V) => R,
vars: V,
): Promise<Awaited<R>[]>
Type Parameters
- R
- V extends Record<string, unknown>
Parameters
- func: (_: this, vars: V) => R
- vars: V
Returns Promise<Awaited<R>[]>
- Defined in src/client/workerclient.ts:436

uploadCommands

uploadCommands(
__namedParameters?: { applicationId?: string; cachePath?: string },
): Promise<void>
Parameters
- __namedParameters: { applicationId?: string; cachePath?: string } = {}
Returns Promise<void>
Inherited from BaseClient.uploadCommands
- Defined in src/client/base.ts:343

`Protected` `Static`getBotIdFromToken

getBotIdFromToken(token: string): string
Parameters
- token: string
Returns string
Inherited from BaseClient.getBotIdFromToken
- Defined in src/client/base.ts:101

Class WorkerClient<Ready>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WorkerClient<Ready>

Properties

applications

bans

cache

channels

collectors

commands

components

Optionaldebugger

emojis

events

guilds

handleCommand

interactions

invites

langs

logger

me

members

memberUpdateHandler

messages

Optionalmiddlewares

options

presenceUpdateHandler

promises

reactions

resharding

rest

roles

shards

soundboards

templates

threads

users

voiceStates

webhooks

Accessors

applicationId

Returns string

Parameters

Returns void

botId

Returns string

Parameters

Returns void

latency

Returns number

proxy

Returns APIRoutes

workerData

Returns WorkerData

workerId

Returns number

Methods

calculateShardId

Parameters

Returns number

createShard

Parameters

Returns Shard

Protectedexecute

Parameters

Returns Promise<void>

getRC

Type Parameters

Returns Promise< { debug: boolean } & Omit<T, "debug" | "locations"> & { locations: RCLocations; },>

handleManagerMessages

`Optional`debugger

`Optional`middlewares

`Protected`execute

Returns Promise<
{ debug: boolean } & Omit<T, "debug" | "locations"> & {
locations: RCLocations;
},
>

Returns Promise<
{
headers: { "Content-Type"?: string };
response: APIInteractionResponse | FormData;
},
>

`Protected`onPacket

`Protected` `Static`getBotIdFromToken