Class GilClient

Hierarchy

GilClient

Index

Constructors

constructor

new GilClient(options): GilClient
Parameters
- options: GilClientOptions
Returns GilClient
- Defined in GilClient.ts:54

Properties

`Readonly` client

client: Client = ...

`Readonly` commands

commands: CommandManager = ...

`Readonly` db

db: DatabaseAdapter = ...

`Readonly` emitter

emitter: TypedEventEmitter<GilEvents> = ...

`Readonly` idGenerator

idGenerator: (() => string) = ...

Type declaration

- (): string
- Returns string

`Readonly` listeners

listeners: ListenerManager = ...

`Readonly` logger

logger: LoggerAdapter = ...

options

options: GilClientOptions

`Readonly` responses

responses: {
    errorCommand: ((p) => Embed);
    invalidArguments: ((p) => Embed);
    noop: (() => string);
    serverNotPremium: ((p) => Embed);
    userMissingRole: ((p) => Embed);
    userNotPremium: ((p) => Embed);
} = ...

Type declaration

errorCommand: ((p) => Embed)
- - (p): Embed
  - Parameters
    - p: {
          error_id: string;
          error_message: string;
          support_server?: string;
      }
      
      error_id: string
      
      error_message: string
      
      Optional support_server?: string
    Returns Embed
invalidArguments: ((p) => Embed)
- - (p): Embed
  - Parameters
    - p: {
      extra_info: unknown;
      reason_code: string;
      }
      
      extra_info: unknown
      
      reason_code: string
    Returns Embed
noop: (() => string)
- - (): string
  - Returns string
serverNotPremium: ((p) => Embed)
- - (p): Embed
  - Parameters
    - p: {
      tier: string;
      }
      
      tier: string
    Returns Embed
userMissingRole: ((p) => Embed)
- - (p): Embed
  - Parameters
    - p: {
      requiredRole: string[];
      }
      
      requiredRole: string[]
    Returns Embed
userNotPremium: ((p) => Embed)
- - (p): Embed
  - Parameters
    - p: {
      tier: string;
      }
      
      tier: string
    Returns Embed

`Readonly` tasks

tasks: TaskManager = ...

Methods

`Private` hookClientInternals

hookClientInternals(): void
Returns void
- Defined in GilClient.ts:82

send

send<T>(channel, key, options?): Promise<Message>
Type Parameters
- T extends "userMissingRole" | "serverNotPremium" | "userNotPremium" | "invalidArguments" | "errorCommand" | "noop"
Parameters
- channel: {
  channelId: string;
  }
  - channelId: string
- key: T
- Optional options: {
  args: DefaultResponseParams[T][0];
  }
  - args: DefaultResponseParams[T][0]
Returns Promise<Message>
- Defined in GilClient.ts:69

start

start(): Promise<void>
Returns Promise<void>
- Defined in GilClient.ts:59

Class GilClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: GilClientOptions

Returns GilClient

Properties

Readonly client

Readonly commands

Readonly db

Readonly emitter

Readonly idGenerator

Type declaration

Returns string

Readonly listeners

Readonly logger

options

Readonly responses

Type declaration

errorCommand: ((p) => Embed)

Parameters

p: { error_id: string; error_message: string; support_server?: string; }

error_id: string

error_message: string

Optional support_server?: string

Returns Embed

invalidArguments: ((p) => Embed)

Parameters

p: { extra_info: unknown; reason_code: string; }

extra_info: unknown

reason_code: string

Returns Embed

noop: (() => string)

Returns string

serverNotPremium: ((p) => Embed)

Parameters

p: { tier: string; }

tier: string

Returns Embed

userMissingRole: ((p) => Embed)

Parameters

p: { requiredRole: string[]; }

requiredRole: string[]

Returns Embed

userNotPremium: ((p) => Embed)

Parameters

p: { tier: string; }

tier: string

Returns Embed

Readonly tasks

Methods

Private hookClientInternals

Returns void

send

Type Parameters

T extends "userMissingRole" | "serverNotPremium" | "userNotPremium" | "invalidArguments" | "errorCommand" | "noop"

Parameters

channel: { channelId: string; }

channelId: string

key: T

Optional options: { args: DefaultResponseParams[T][0]; }

args: DefaultResponseParams[T][0]

Returns Promise<Message>

start

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Readonly` client

`Readonly` commands

`Readonly` db

`Readonly` emitter

`Readonly` idGenerator

`Readonly` listeners

`Readonly` logger

`Readonly` responses

p: {
error_id: string;
error_message: string;
support_server?: string;
}

`Optional` support_server?: string

p: {
extra_info: unknown;
reason_code: string;
}

p: {
tier: string;
}

p: {
requiredRole: string[];
}

p: {
tier: string;
}

`Readonly` tasks

`Private` hookClientInternals

channel: {
channelId: string;
}

`Optional` options: {
args: DefaultResponseParams[T][0];
}