@klasa/core

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActivityResolvable

Channels

Channels: DMChannel | GuildBasedChannel

Constructor

Constructor<T>: {}

Type parameters

Type declaration

GuildTextBasedChannel

GuildTextBasedChannel: TextChannel | NewsChannel

ImageBufferResolvable

ImageBufferResolvable: Readable | Buffer | MessageAttachment | string

MemberData

MemberData: APIGuildMemberData | Omit<APIGuildMemberData, "deaf" | "mute" | "nick" | "joined_at">

MessageFlagsResolvable

MessageIteratorOptions

MessageIteratorOptions: EventIteratorOptions<[Message]>

OverwriteData

OverwriteData: Omit<APIOverwriteData, "id">

PermissionsResolvable

PieceConstructor

PieceConstructor<T>: {}

Type parameters

Type declaration

PresenceStatus

PresenceStatus: PresenceUpdateData["status"]

ReactionIteratorOptions

ReactionIteratorOptions: EventIteratorOptions<[MessageReaction, User]>

SpeakingResolvable

TextBasedChannel

TextBasedChannel: DMChannel | GuildTextBasedChannel

UserFlagsResolvable

Variables

Const Package

Package: any = require('../../../../package.json')

Const extender

extender: Extender = new Extender().add('Ban', Ban).add('CategoryChannel', CategoryChannel).add('Channel', Channel).add('ClientUser', ClientUser).add('DMChannel', DMChannel).add('Guild', Guild).add('GuildChannel', GuildChannel).add('GuildEmoji', GuildEmoji).add('GuildMember', GuildMember).add('Integration', Integration).add('Invite', Invite).add('Message', Message).add('MessageReaction', MessageReaction).add('NewsChannel', NewsChannel).add('Overwrite', Overwrite).add('Presence', Presence).add('Role', Role).add('StoreChannel', StoreChannel).add('Team', Team).add('TeamMember', TeamMember).add('TextChannel', TextChannel).add('User', User).add('VoiceChannel', VoiceChannel).add('VoiceState', VoiceState)

The exported singleton instance of the Extender class.

version

version: any

Functions

getImageType

getImageType(buffer: Buffer): ImageTypes | null

- Defined in src/lib/util/ImageUtil.ts:86
Determines whether or not a buffer corresponds to a GIF, JPG/JPEG, PNG, or WebP.

since

0.0.1

Parameters
- buffer: Buffer
  
  The buffer to sniff the magic numbers from.
Returns ImageTypes | null

imageToBase64

imageToBase64(buffer: Buffer, fallback?: ImageTypes): string

- Defined in src/lib/util/ImageUtil.ts:100
Determines the image's file type based on its contents and provides a base 64 string.

since

0.0.1

Parameters
- buffer: Buffer
  
  The buffer to sniff and stringify into a Base 64 string.
- Default value fallback: ImageTypes = ImageTypes.JPEG
  
  The default image type to fall back to.
Returns string

Private isGif

isGif(buffer: Buffer): boolean

- Defined in src/lib/util/ImageUtil.ts:12
see

https://en.wikipedia.org/wiki/GIF

Parameters
- buffer: Buffer
  
  The buffer the sniff the magic numbers from.
Returns boolean

isGuildChannel

isGuildChannel(channel: Channel): channel is GuildBasedChannel

- Defined in src/lib/util/Util.ts:35
Parameters
- channel: Channel
Returns channel is GuildBasedChannel

isGuildTextBasedChannel

isGuildTextBasedChannel(channel: Channel): channel is GuildTextBasedChannel

- Defined in src/lib/util/Util.ts:31
Parameters
- channel: Channel
Returns channel is GuildTextBasedChannel

Private isJpeg

isJpeg(buffer: Buffer): boolean

- Defined in src/lib/util/ImageUtil.ts:28
see

https://en.wikipedia.org/wiki/JPEG

Parameters
- buffer: Buffer
  
  The buffer the sniff the magic numbers from.
Returns boolean

Private isPng

isPng(buffer: Buffer): boolean

- Defined in src/lib/util/ImageUtil.ts:41
see

https://en.wikipedia.org/wiki/Portable_Network_Graphics

Parameters
- buffer: Buffer
  
  The buffer the sniff the magic numbers from.
Returns boolean

isSet

isSet<V, K>(value: V, key: K): value is V & Required<Pick<V, K>>

- Defined in src/lib/util/Util.ts:40
Type parameters
- V: {}
- K: keyof V
Parameters
- value: V
- key: K
Returns value is V & Required<Pick<V, K>>

isTextBasedChannel

isTextBasedChannel(channel: Channel): channel is TextBasedChannel

- Defined in src/lib/util/Util.ts:27
Parameters
- channel: Channel
Returns channel is TextBasedChannel

Private isWebp

isWebp(buffer: Buffer): boolean

- Defined in src/lib/util/ImageUtil.ts:59
see

https://en.wikipedia.org/wiki/WebP

Parameters
- buffer: Buffer
  
  The buffer the sniff the magic numbers from.
Returns boolean

resolveEmoji

resolveEmoji(emoji: EmojiResolvable): string

- Defined in src/lib/util/Util.ts:46
Parameters
- emoji: EmojiResolvable
Returns string

resolveImageBuffer

resolveImageBuffer(data: ImageBufferResolvable): Promise<Buffer>

- Defined in src/lib/util/ImageUtil.ts:109
Converts a stream, buffer, message attachment, url, or filepath to a buffer.

since

0.0.1

Parameters
- data: ImageBufferResolvable
  
  The data to resolve into a buffer.
Returns Promise<Buffer>

resolveImageToBase64

resolveImageToBase64(data: ImageBufferResolvable, fallback?: ImageTypes): Promise<string>

- Defined in src/lib/util/ImageUtil.ts:128
Determines the image's file type based on its contents and provides a base 64 string.

since

0.0.1

Parameters
- data: ImageBufferResolvable
  
  The data to resolve into a Base 64 string.
- Optional fallback: ImageTypes
  
  The default image type to fall back to.
Returns Promise<string>

snakeToCamel

snakeToCamel(input: string): string

- Defined in src/lib/util/Util.ts:11
Parameters
- input: string
Returns string

Object literals

Const BaseClientOptionsDefaults

BaseClientOptionsDefaults: object

rest

rest: {} = RestOptionsDefaults

Type declaration

Const ClientOptionsDefaults

ClientOptionsDefaults: object

ws

ws: {} = WSOptionsDefaults

Type declaration

cache

cache: object

enabled

enabled: true = true

messageLifetime

messageLifetime: number = 0

messageSweepInterval

messageSweepInterval: number = 0

limits

limits: object

bans

bans: number = Infinity

channels

channels: number = Infinity

dms

dms: number = Infinity

emojis

emojis: number = Infinity

guilds

guilds: number = Infinity

integrations

integrations: number = Infinity

invites

invites: number = Infinity

members

members: number = Infinity

messages

messages: number = 100

overwrites

overwrites: number = Infinity

presences

presences: number = Infinity

reactions

reactions: number = Infinity

roles

roles: number = Infinity

users

users: number = Infinity

voiceStates

voiceStates: number = Infinity

pieces

pieces: object

createFolders

createFolders: false = false

disabledCoreTypes

disabledCoreTypes: never[] = []

defaults

defaults: object

events

events: object

enabled

enabled: true = true

once

once: false = false

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActivityResolvable

Channels

Constructor

Type parameters

T

Type declaration

EmojiResolvable

GuildBasedChannel

GuildPruneOptions

GuildTextBasedChannel

ImageBufferResolvable

MemberData

MessageFlagsResolvable

MessageIteratorOptions

OverwriteData

PermissionsResolvable

PieceConstructor

Type parameters

T

Type declaration

PresenceStatus

ReactionIteratorOptions

SpeakingResolvable

TextBasedChannel

UserFlagsResolvable

Variables

Const Package

Const extender

version

Functions

getImageType

Parameters

buffer: Buffer

Returns ImageTypes | null

imageToBase64

Parameters

buffer: Buffer

Default value fallback: ImageTypes = ImageTypes.JPEG

Returns string

Private isGif

Parameters

buffer: Buffer

Returns boolean

isGuildChannel

Parameters

channel: Channel

Returns channel is GuildBasedChannel

isGuildTextBasedChannel

Parameters

channel: Channel

Returns channel is GuildTextBasedChannel

Private isJpeg

Parameters

buffer: Buffer

Returns boolean

Private isPng

Parameters

buffer: Buffer

Returns boolean

isSet

Type parameters

V: {}

K: keyof V

Parameters

value: V

key: K

Returns value is V & Required<Pick<V, K>>

isTextBasedChannel

Parameters

channel: Channel

Returns channel is TextBasedChannel