Class Typing

Channel Typing Structure used to tell you when someone starts typing in a channel

Hierarchy

BaseStructure
- Typing

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Typing(client: ShardClient, data?: BaseStructureData, isClone?: boolean): Typing

Overrides BaseStructure.constructor
- Defined in src/structures/typing.ts:49
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Typing

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Readonly _keysMerge

_keysMerge: BaseSet<string> = ...

channelId

channelId: string = ''

Readonly client

client: ShardClient

Optional guildId

guildId: string

Optional member

member: Member

started

started: number = 0

stopped

stopped: number = 0

Readonly timeout

timeout: Timeout = ...

timestamp

timestamp: number = 0

userId

userId: string = ''

Accessors

channel

get channel(): null | Channel

- Defined in src/structures/typing.ts:62
Returns null | Channel

guild

get guild(): null | Guild

- Defined in src/structures/typing.ts:66
Returns null | Guild

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

shouldStopAt

get shouldStopAt(): number

- Defined in src/structures/typing.ts:73
Returns number

user

get user(): null | User

- Defined in src/structures/typing.ts:77
Returns null | User

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

_stop

_stop(emit?: boolean): void

- Defined in src/structures/typing.ts:81
Parameters
- emit: boolean = true
Returns void

clone

clone(): Typing

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Typing

difference

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

mergeValue(key: string, value: any): void

Overrides BaseStructure.mergeValue
- Defined in src/structures/typing.ts:101
Parameters
- key: string
- value: any
Returns void

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Generated using TypeDoc