Class Selector<T, TInt, TRet>`Abstract`

Type Parameters

T extends SelectorTypes
TInt extends MessageComponentInteraction
TRet

Hierarchy (view full)

ExtraElement
- Selector
  - ChannelSelector
  - StringSelector

Index

Constructors

Properties

customId max min onSelect placeholder

Methods

build getSelect getValues isValidInteraction onInteraction typeSafeIsValidInteraction

Constructors

constructor

new Selector<T, TInt, TRet>(placeholder, onSelect, min?, max?): Selector<T, TInt, TRet>
Type Parameters
- T extends SelectorTypes
- TInt extends MessageComponentInteraction<CacheType>
- TRet
Parameters
- placeholder: string
- onSelect: ((msg, objs) => any)
  - - (msg, objs): any
    - Parameters
      msg: TInt
      objs: TRet[]
      Returns any
- min: number = null
- max: number = null
Returns Selector<T, TInt, TRet>
Overrides ExtraElement.constructor
- Defined in src/navigation.ts:50

Properties

`Readonly` customId

customId: string = ...

`Readonly` max

max: number

`Readonly` min

min: number

`Readonly` onSelect

onSelect: ((msg, objs) => any)

Type declaration

- (msg, objs): any
- Parameters
  - msg: TInt
  - objs: TRet[]
  Returns any

`Readonly` placeholder

placeholder: string

Methods

build

build(): StringSelectMenuBuilder | UserSelectMenuBuilder | RoleSelectMenuBuilder | MentionableSelectMenuBuilder | ChannelSelectMenuBuilder
Returns StringSelectMenuBuilder | UserSelectMenuBuilder | RoleSelectMenuBuilder | MentionableSelectMenuBuilder | ChannelSelectMenuBuilder
Overrides ExtraElement.build
- Defined in src/navigation.ts:59

`Protected` `Abstract` getSelect

getSelect(): T
Returns T
- Defined in src/navigation.ts:78

`Protected` `Abstract` getValues

getValues(msg): TRet[]
Parameters
- msg: TInt
Returns TRet[]
- Defined in src/navigation.ts:79

isValidInteraction

isValidInteraction(msg): boolean
Parameters
- msg: MessageComponentInteraction<CacheType>
Returns boolean
Overrides ExtraElement.isValidInteraction
- Defined in src/navigation.ts:74

onInteraction

onInteraction(msg): Promise<void>
Parameters
- msg: MessageComponentInteraction<CacheType>
Returns Promise<void>
Overrides ExtraElement.onInteraction
- Defined in src/navigation.ts:68

`Protected` `Abstract` typeSafeIsValidInteraction

typeSafeIsValidInteraction(msg): msg is TInt
Typesafe version of isValidInteraction. Override this method instead;
Parameters
- msg: MessageComponentInteraction<CacheType>
  Interaction
Returns msg is TInt
- Defined in src/navigation.ts:85