Class DMManager

Hierarchy

DMManager

Index

Constructors

constructor

new DMManager(token, mongodb, restOptions?): DMManager
Parameters
- token: string
  
  Your Bot's Discord Token
- mongodb: XOR<MongoClient, {
  options?: Partial<MongoOptions>;
  url: string;
  }>
- Optional restOptions: Partial<RESTOptions>
Returns DMManager
- Defined in src/index.ts:15

Properties

`Private` #cache

#cache: Map<string, string> = ...

`Private` #client

#client: MongoClient

`Private` #errorHandler

#errorHandler: ((error) => null) = noop

Type declaration

- (error): null
- Parameters
  - error: unknown
  Returns null

`Private` #rest

#rest: REST

`Private` token

token: string

Your Bot's Discord Token

Accessors

db

get db(): Collection<Document>
Returns Collection<Document>
- Defined in src/index.ts:48

dms

get dms(): {
    cache: ((userId, channelId) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    createDMChannel: ((userId) => Promise<null | string>);
    get: ((userId, force?) => Promise<{
        message: string;
        status: false;
    } | {
        channelId: string;
        status: true;
    }>);
    recache: (() => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    remove: ((userId) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    removeAllChannel: ((channelIds) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
}
Returns {
    cache: ((userId, channelId) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    createDMChannel: ((userId) => Promise<null | string>);
    get: ((userId, force?) => Promise<{
        message: string;
        status: false;
    } | {
        channelId: string;
        status: true;
    }>);
    recache: (() => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    remove: ((userId) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    removeAllChannel: ((channelIds) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
}
- cache: ((userId, channelId) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (userId, channelId): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      userId: string
      
      channelId: string
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- createDMChannel: ((userId) => Promise<null | string>)
  - - (userId): Promise<null | string>
    - Parameters
      
      userId: string
      Returns Promise<null | string>
- get: ((userId, force?) => Promise<{
      message: string;
      status: false;
  } | {
      channelId: string;
      status: true;
  }>)
  - - (userId, force?): Promise<{
          message: string;
          status: false;
      } | {
          channelId: string;
          status: true;
      }>
    - Parameters
      
      userId: string
      
      Optional force: boolean
      Returns Promise<{
          message: string;
          status: false;
      } | {
          channelId: string;
          status: true;
      }>
- recache: (() => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- remove: ((userId) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (userId): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      userId: string
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- removeAllChannel: ((channelIds) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (channelIds): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      channelIds: string[]
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- Defined in src/index.ts:52

`Private` id

get id(): string
Returns string
- Defined in src/index.ts:39

Methods

`Private` #api

#api<D, B>(route, options?, channelId?): Promise<null | D>
Type Parameters
- D
- B = unknown
Parameters
- route: `/${string}`
- Optional options: {
      auth?: boolean;
      body?: B;
      files?: RawFile[];
      method?: "get" | "post" | "patch" | "delete";
      query?: URLSearchParams;
      reason?: string;
  }
  - Optional auth?: boolean
  - Optional body?: B
  - Optional files?: RawFile[]
  - Optional method?: "get" | "post" | "patch" | "delete"
  - Optional query?: URLSearchParams
  - Optional reason?: string
- Optional channelId: string
Returns Promise<null | D>
- Defined in src/index.ts:226

`Private` #dm

#dm(userId, clientId?): string
Parameters
- userId: string
- Optional clientId: string
Returns string
- Defined in src/index.ts:204

send

send(options): Promise<null | {
message: string;
status: false;
} | APIMessage>
Parameters
- options: DMOptions
Returns Promise<null | {
message: string;
status: false;
} | APIMessage>
- Defined in src/index.ts:208

setErrorHandler

setErrorHandler(handler?): DMManager
Parameters
- Optional handler: ((error) => null)
  - - (error): null
    - Parameters
      
      error: unknown
      
      Returns null
Returns DMManager
- Defined in src/index.ts:43

Class DMManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

token: string

mongodb: XOR<MongoClient, { options?: Partial<MongoOptions>; url: string; }>

Optional restOptions: Partial<RESTOptions>

Returns DMManager

Properties

Private #cache

Private #client

Private #errorHandler

Type declaration

Parameters

error: unknown

Returns null

Private #rest

Private token

Accessors

db

Returns Collection<Document>

dms

cache: ((userId, channelId) => Promise<{ message: string; status: false; } | { message: string; status: true; }>)

Parameters

userId: string

channelId: string

Returns Promise<{ message: string; status: false; } | { message: string; status: true; }>

createDMChannel: ((userId) => Promise<null | string>)

Parameters

userId: string

Returns Promise<null | string>

get: ((userId, force?) => Promise<{ message: string; status: false; } | { channelId: string; status: true; }>)

Parameters

userId: string

Optional force: boolean

Returns Promise<{ message: string; status: false; } | { channelId: string; status: true; }>

recache: (() => Promise<{ message: string; status: false; } | { message: string; status: true; }>)

Returns Promise<{ message: string; status: false; } | { message: string; status: true; }>

remove: ((userId) => Promise<{ message: string; status: false; } | { message: string; status: true; }>)

Parameters

userId: string

Returns Promise<{ message: string; status: false; } | { message: string; status: true; }>

removeAllChannel: ((channelIds) => Promise<{ message: string; status: false; } | { message: string; status: true; }>)

Parameters

channelIds: string[]

Returns Promise<{ message: string; status: false; } | { message: string; status: true; }>

Private id

Returns string

Methods

Private #api

Type Parameters

D

B = unknown

Parameters

route: `/${string}`

Optional options: { auth?: boolean; body?: B; files?: RawFile[]; method?: "get" | "post" | "patch" | "delete"; query?: URLSearchParams; reason?: string; }

Optional auth?: boolean

Optional body?: B

Optional files?: RawFile[]

Optional method?: "get" | "post" | "patch" | "delete"

Optional query?: URLSearchParams

Optional reason?: string

Optional channelId: string

Returns Promise<null | D>

Private #dm

Parameters

userId: string

Optional clientId: string

Returns string

send

Parameters

options: DMOptions

Returns Promise<null | { message: string; status: false; } | APIMessage>

setErrorHandler

mongodb: XOR<MongoClient, {
options?: Partial<MongoOptions>;
url: string;
}>

`Optional` restOptions: Partial<RESTOptions>

`Private` #cache

`Private` #client

`Private` #errorHandler

`Private` #rest

`Private` token

cache: ((userId, channelId) => Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>

get: ((userId, force?) => Promise<{
message: string;
status: false;
} | {
channelId: string;
status: true;
}>)

`Optional` force: boolean

Returns Promise<{
message: string;
status: false;
} | {
channelId: string;
status: true;
}>

recache: (() => Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>

remove: ((userId) => Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>

removeAllChannel: ((channelIds) => Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>

`Private` id

`Private` #api

`Optional` options: {
auth?: boolean;
body?: B;
files?: RawFile[];
method?: "get" | "post" | "patch" | "delete";
query?: URLSearchParams;
reason?: string;
}

`Optional` auth?: boolean

`Optional` body?: B

`Optional` files?: RawFile[]

`Optional` method?: "get" | "post" | "patch" | "delete"

`Optional` query?: URLSearchParams

`Optional` reason?: string

`Optional` channelId: string

`Private` #dm

`Optional` clientId: string

Returns Promise<null | {
message: string;
status: false;
} | APIMessage>

`Optional` handler: ((error) => null)