Skip to content

Latest commit

 

History

History
173 lines (101 loc) · 4.1 KB

Client.clientOptions.md

File metadata and controls

173 lines (101 loc) · 4.1 KB

fuwa.js / Exports / Client / clientOptions

Interface: clientOptions

Client.clientOptions

Table of contents

Properties

Methods

Properties

applicationId

Optional applicationId: string

Defined in

src/lib/Client.ts:91


builtinCommands

Optional builtinCommands: Object

Type declaration

Name Type
help? false | { embedColor?: string | number }

Defined in

src/lib/Client.ts:100


cache

Optional cache: true

If the bot should cache guilds/channels/users or not. It's suggested to keep this on for smaller bots but for larger ones turn this off, caching increases the speed of sending messages, but takes up memory. meaning caching on = faster guild replies caching off = more memory for other tasks

Defined in

src/lib/Client.ts:129


cachingSettings

Optional cachingSettings: Object

Settings for caching

Type declaration

Name Type Description
cacheOptions? Object -
cacheOptions.channels boolean -
cacheOptions.guilds boolean -
cacheOptions.users boolean -
clearAfter? number | false Clear the cache after a certain amount of time (in ms) If this is false then the cache will never be cleared
maxSize? number Maximum amount of items to cache at once. Set this to 0 if you want an unlimited cache size

Defined in

src/lib/Client.ts:133


debug

Optional debug: boolean

To turn on the debug mode, not recommed to turn this on unless your debugging the library.

Defined in

src/lib/Client.ts:89


intents

intents: number

see GatewayIntents

Defined in

src/lib/Client.ts:111


owners

Optional owners: string | string[]

The owners' discord ID

Defined in

src/lib/Client.ts:84


shards

Optional shards: number

Defined in

src/lib/Client.ts:90


useMentionPrefix

Optional useMentionPrefix: boolean

If this is turned on (true) When someone mentions your bot it will behave as a prefix.

Defined in

src/lib/Client.ts:96

Methods

parser

parser(prefix, msg, options): false | [{ cb: CommandCallback ; options: commandOptions }[], string[]]

The

Parameters

Name Type
prefix string
msg Message
options clientOptions

Returns

false | [{ cb: CommandCallback ; options: commandOptions }[], string[]]

Defined in

src/lib/Client.ts:115