Class HttpClient

Hierarchy

BaseClient
- HttpClient

Constructors

constructor

new HttpClient(options?: BaseClientOptions): HttpClient
Parameters
- Optionaloptions: BaseClientOptions
Returns HttpClient
Overrides BaseClient.constructor
- Defined in src/client/httpclient.ts:6

Properties

applications

applications: ApplicationShorter = ...

bans

bans: BanShorter = ...

cache

cache: Cache = ...

channels

channels: ChannelShorter = ...

commands

commands: CommandHandler = ...

components

components: ComponentHandler = ...

`Optional`debugger

debugger?: Logger

emojis

emojis: EmojiShorter = ...

guilds

guilds: GuildShorter = ...

handleCommand

handleCommand: HandleCommand

interactions

interactions: InteractionShorter = ...

invites

invites: InvitesShorter = ...

langs

langs: LangsHandler = ...

logger

logger: Logger = ...

members

members: MemberShorter = ...

messages

messages: MessageShorter = ...

`Optional`middlewares

middlewares?: Record<string, MiddlewareContext>

options

options: BaseClientOptions

reactions

reactions: ReactionShorter = ...

rest

rest: ApiHandler = ...

roles

roles: RoleShorter = ...

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
Inherited from BaseClient.applicationId
- Defined in src/client/base.ts:190
set applicationId(id: string): void
Parameters
- id: string
Returns void
Inherited from BaseClient.applicationId
- Defined in src/client/base.ts:186

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

proxy

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

Methods

`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

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

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: unknown[]): Promise<any>
Parameters
- ..._packet: unknown[]
Returns Promise<any>
Inherited from BaseClient.onPacket
- Defined in src/client/base.ts:278

setServices

setServices(__namedParameters: ServicesOptions): void
Parameters
- __namedParameters: ServicesOptions
Returns void
Inherited from BaseClient.setServices
- Defined in src/client/base.ts:194

start

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

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

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 HttpClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns HttpClient

Properties

applications

bans

cache

channels

commands

components

Optionaldebugger

emojis

guilds

handleCommand

interactions

invites

langs

logger

members

messages

Optionalmiddlewares

options

reactions

rest

roles

soundboards

templates

threads

users

voiceStates

webhooks

Accessors

applicationId

Returns string

Parameters

Returns void

botId

Returns string

Parameters

Returns void

proxy

Returns APIRoutes

Methods

Protectedexecute

Parameters

Returns Promise<void>

getRC

Type Parameters

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

loadCommands

Parameters

Returns Promise<void>

loadComponents

Parameters

Returns Promise<void>

loadLangs

Parameters

Returns Promise<void>

onInteractionRequest

Parameters

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

ProtectedonPacket

Parameters

Returns Promise<any>

setServices

Parameters

Returns void

start

Parameters

Returns Promise<void>

t

Parameters

`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