Class DOn

Hierarchy

Method
- DOn

Index

Constructors

constructor

new DOn(data): DOn
Parameters
- data: CreateStructure
Returns DOn
Overrides Method.constructor
- Defined in packages/discordx/src/decorators/classes/DOn.ts:62

Properties

`Protected`_botIds

_botIds: string[]

`Protected`_classRef

_classRef: Record<string, any>

`Protected`_discord

_discord: DDiscord

`Protected`_event

_event: string

`Protected`_from

_from: Record<string, any>

`Protected`_guards

_guards: DGuard[] = []

`Protected` `Optional`_index

_index?: number

`Protected`_key

_key: string

`Protected` `Optional`_method

_method?: Record<string, any>

`Protected`_once

_once: boolean

`Protected`_priority

_priority: number

`Protected`_rest

_rest: boolean

Accessors

botIds

get botIds(): string[]
Returns string[]
- Defined in packages/discordx/src/decorators/classes/DOn.ts:27
set botIds(value): void
Parameters
- value: string[]
Returns void
- Defined in packages/discordx/src/decorators/classes/DOn.ts:30

classRef

get classRef(): Record<string, any>
Gets or sets the class reference being decorated.

Returns Record<string, any>
Inherited from Method.classRef
- Defined in packages/internal/dist/index.d.mts:18
set classRef(value): void
Parameters
- value: Record<string, any>
Returns void
Inherited from Method.classRef
- Defined in packages/internal/dist/index.d.mts:19

discord

get discord(): DDiscord
Returns DDiscord
Inherited from Method.discord
- Defined in packages/discordx/src/decorators/classes/Method.ts:19
set discord(value): void
Parameters
- value: DDiscord
Returns void
Inherited from Method.discord
- Defined in packages/discordx/src/decorators/classes/Method.ts:22

event

get event(): string
Returns string
- Defined in packages/discordx/src/decorators/classes/DOn.ts:34
set event(value): void
Parameters
- value: string
Returns void
- Defined in packages/discordx/src/decorators/classes/DOn.ts:37

execute

get execute(): ((guards: GuardFunction[], ...params: unknown[]) => Promise<unknown>)
Compiled methods executes all the guards and the main method
```
compiledMethod = async (params: ArgsOf<any>, client: Client) => {
  guard1(params, client)
  guard2(params, client)
  guard3(params, client)
  main(params, client)
}
```
Returns ((guards: GuardFunction[], ...params: unknown[]) => Promise<unknown>)
- - (guards, ...params): Promise<unknown>
  - Parameters
    - guards: GuardFunction[]
    - Rest...params: unknown[]
    Returns Promise<unknown>
Inherited from Method.execute
- Defined in packages/discordx/src/decorators/classes/Method.ts:38

from

get from(): Record<string, any>
Gets or sets the originating class reference.

Returns Record<string, any>
Inherited from Method.from
- Defined in packages/internal/dist/index.d.mts:23
set from(value): void
Parameters
- value: Record<string, any>
Returns void
Inherited from Method.from
- Defined in packages/internal/dist/index.d.mts:24

guards

get guards(): DGuard[]
Returns all the guards of the application The guards that are defined globally with Client The guards that decorate

Returns DGuard[]
Discord
The guards that decorate the method (this)
Inherited from Method.guards
- Defined in packages/discordx/src/decorators/classes/Method.ts:56
set guards(value): void
Parameters
- value: DGuard[]
Returns void
Inherited from Method.guards
- Defined in packages/discordx/src/decorators/classes/Method.ts:63

index

get index(): undefined | number
Gets the index of the parameter being decorated, if applicable.

Returns undefined | number
Inherited from Method.index
- Defined in packages/internal/dist/index.d.mts:14

isClass

get isClass(): boolean
Determines if the target is a class.

Returns boolean
Inherited from Method.isClass
- Defined in packages/internal/dist/index.d.mts:36

key

get key(): string
Gets the key of the property or method being decorated.

Returns string
Inherited from Method.key
- Defined in packages/internal/dist/index.d.mts:28

method

get method(): undefined | Record<string, any>
Gets the method descriptor if the target is a method.

Returns undefined | Record<string, any>
Inherited from Method.method
- Defined in packages/internal/dist/index.d.mts:32

once

get once(): boolean
Returns boolean
- Defined in packages/discordx/src/decorators/classes/DOn.ts:41
set once(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/discordx/src/decorators/classes/DOn.ts:44

priority

get priority(): number
Returns number
- Defined in packages/discordx/src/decorators/classes/DOn.ts:48
set priority(value): void
Parameters
- value: number
Returns void
- Defined in packages/discordx/src/decorators/classes/DOn.ts:51

rest

get rest(): boolean
Returns boolean
- Defined in packages/discordx/src/decorators/classes/DOn.ts:55
set rest(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/discordx/src/decorators/classes/DOn.ts:58

Methods

decorate

decorate(classRef, key, method?, from?, index?): this
Applies the decoration to the specified target.
Parameters
- classRef: Record<string, any>
  The class reference.
- key: string
  The property key.
- Optionalmethod: Record<string, any>
  The method descriptor.
- Optionalfrom: Record<string, any>
  The originating class reference.
- Optionalindex: number
  The parameter index.
Returns this
The current instance.
Inherited from Method.decorate
- Defined in packages/internal/dist/index.d.mts:55

decorateUnknown

decorateUnknown(classRef, key?, method?, index?): this
Decorates an unknown type (class, method, or property).
Parameters
- classRef: Record<string, any>
  The class reference.
- Optionalkey: string
  The property key.
- Optionalmethod: PropertyDescriptor
  The method descriptor.
- Optionalindex: number
  The parameter index.
Returns this
The current instance.
Inherited from Method.decorateUnknown
- Defined in packages/internal/dist/index.d.mts:45

getGuardFunction

getGuardFunction(globalGuards): ((...params: unknown[]) => Promise<unknown>)
Execute a guard with params
Parameters
- globalGuards: DGuard[]
Returns ((...params: unknown[]) => Promise<unknown>)
- - (...params): Promise<unknown>
  - Parameters
    - Rest...params: unknown[]
    Returns Promise<unknown>
Inherited from Method.getGuardFunction
- Defined in packages/discordx/src/decorators/classes/Method.ts:77

isBotAllowed

isBotAllowed(botId): boolean
Parameters
- botId: string
Returns boolean
- Defined in packages/discordx/src/decorators/classes/DOn.ts:75

parseParams

parseParams(): never[]
Define how to parse the params

Returns never[]
Overrides Method.parseParams
- Defined in packages/discordx/src/decorators/classes/DOn.ts:83

`Static`create

create(data): DOn
Parameters
- data: CreateStructure
Returns DOn
- Defined in packages/discordx/src/decorators/classes/DOn.ts:71

Class DOn

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DOn

Properties

Protected_botIds

Protected_classRef

Protected_discord

Protected_event

Protected_from

Protected_guards

Protected Optional_index

Protected_key

Protected Optional_method

Protected_once

Protected_priority

Protected_rest

Accessors

botIds

Returns string[]

Parameters

Returns void

classRef

Returns Record<string, any>

Parameters

Returns void

discord

Returns DDiscord

Parameters

Returns void

event

Returns string

Parameters

Returns void

execute

Returns ((guards: GuardFunction[], ...params: unknown[]) => Promise<unknown>)

Parameters

Returns Promise<unknown>

from

Returns Record<string, any>

Parameters

Returns void

guards

Returns DGuard[]

Discord

Parameters

Returns void

index

Returns undefined | number

isClass

Returns boolean

key

Returns string

method

Returns undefined | Record<string, any>

once

Returns boolean

Parameters

Returns void

priority

Returns number

Parameters

Returns void

rest

Returns boolean

Parameters

Returns void

Methods

decorate

Parameters

Returns this

decorateUnknown

Parameters

`Protected`_botIds

`Protected`_classRef

`Protected`_discord

`Protected`_event

`Protected`_from

`Protected`_guards

`Protected` `Optional`_index

`Protected`_key

`Protected` `Optional`_method

`Protected`_once

`Protected`_priority

`Protected`_rest

`Static`create