Skip to main content

Interface: ClientOptions

types/types.ClientOptions

Properties​

apikey​

• Optional apikey: string

You can request one from ctrlz.

Default

undefined

Defined in​

src/types/types.ts:114

authOptions​

• Optional authOptions: Omit<Partial<{ apikey?: string ; bot?: boolean ; loginkey?: string ; staff?: string ; user: string }>, "bot" | "user" | "apikey">

Options to pass to the auth event.

Defined in​

src/types/types.ts:151

blockBots​

• Optional blockBots: boolean

Whether to block bots

Default

options.bot

Defined in​

src/types/types.ts:140

blockSelf​

• Optional blockSelf: boolean

Whether to ignore events triggered by the current user.

Default

options.bot

Defined in​

src/types/types.ts:94

bot​

• Optional bot: boolean

Whether to mark the user as a bot. Cannot be changed after connecting.

Default

true

Defined in​

src/types/types.ts:134

helpCommandLimit​

• Optional helpCommandLimit: number

The amount of commands to show on one page of the help command.

Default

15

Defined in​

src/types/types.ts:127

helpSuffix​

• Optional helpSuffix: string

A suffix to add to the output of the help command.

Default

""

Defined in​

src/types/types.ts:88

mainPrefix​

• Optional mainPrefix: string | RegExp

The main prefix to use in commands (for example, the help command will use this to tell the user what prefix they should use). This shouldn't have regex in it (although you can) because the average user can't read that. Set this to an empty string to disable the command system.

Default

"The first prefix passed in the constructor."

Defined in​

src/types/types.ts:108

printErrors​

• Optional printErrors: boolean

Whether to print errors to the console. Will not stop printing of fatal errors while loading files.

Default

true

Defined in​

src/types/types.ts:82

server​

• Optional server: string

The server to connect to.

Default

"wss://msgroom.windows96.net"

Defined in​

src/types/types.ts:75

socketIOOptions​

• Optional socketIOOptions: Partial<ManagerOptions & SocketOptions>

Options to pass to socket.io's io() function.

Default

{}

Defined in​

src/types/types.ts:146

unescapeMessages​

• Optional unescapeMessages: boolean

Unescapes the incoming messages, meant for use in bots. It's recommended to disable this when making a custom client.

Default

true

Defined in​

src/types/types.ts:121

welcomeMessage​

• Optional welcomeMessage: string

A message to send when the bot joins.

Deprecated

This option has been removed. As a general rule, bots should not send messages if the user doesn't explicitly ask for them.

Defined in​

src/types/types.ts:100