Class InteractionBuilderImpl<I, D>

An implementation of InteractionBuilder.

Type Parameters

I extends Interaction<D>
D extends InteractionData = InteractionDataType<I>

Implements

InteractionBuilder<I, D>

Index

Constructors

Properties

endPredicate iCtor interactionName startPredicate thenPredicate

Methods

build end first firstAndThen name process then

Constructors

constructor

new InteractionBuilderImpl<I, D>(interactionSupplier): InteractionBuilderImpl<I, D>
Type Parameters
- I extends Interaction<D>
- D extends InteractionData = InteractionDataType<I>
Parameters
- interactionSupplier: ((name?) => I)
  The command that provides an instance of the user interaction to customize.
  - - (name?): I
    - Parameters
      Optional name: string
      Returns I
Returns InteractionBuilderImpl<I, D>
- Defined in impl/interaction/InteractionBuilderImpl.ts:40

Properties

`Private` endPredicate

endPredicate: undefined | ((i) => boolean)

Type declaration

- (i): boolean
- Parameters
  - i: D
  Returns boolean

`Private` `Readonly` iCtor

iCtor: ((name?) => I)

Type declaration

- (name?): I
- Parameters
  - Optional name: string
  Returns I

`Private` interactionName

interactionName: undefined | string

`Private` startPredicate

startPredicate: undefined | ((i) => boolean)

Type declaration

- (i): boolean
- Parameters
  - i: D
  Returns boolean

`Private` thenPredicate

thenPredicate: undefined | ((i) => boolean)

Type declaration

- (i): boolean
- Parameters
  - i: D
  Returns boolean

Methods

build

build(): (() => I)
Returns (() => I)
a command that produces an instance of the customized command.
- - (): I
  - Returns I
Implementation of InteractionBuilder.build
- Defined in impl/interaction/InteractionBuilderImpl.ts:74

end

end(predicate): InteractionBuilderImpl<I, D>
A predicate to execution just before the end of the interaction execution.
Parameters
- predicate: ((i) => boolean)
  The predicate to execute. If it returns true, the interaction is cancelled.
  - - (i): boolean
    - Parameters
      i: D
      Returns boolean
Returns InteractionBuilderImpl<I, D>
Implementation of InteractionBuilder.end
- Defined in impl/interaction/InteractionBuilderImpl.ts:64

first

first(predicate): InteractionBuilderImpl<I, D>
A predicate to execution just before the interaction starts.
Parameters
- predicate: ((i) => boolean)
  The predicate to execute. If it returns true, the interaction is cancelled.
  - - (i): boolean
    - Parameters
      i: D
      Returns boolean
Returns InteractionBuilderImpl<I, D>
Implementation of InteractionBuilder.first
- Defined in impl/interaction/InteractionBuilderImpl.ts:48

firstAndThen

firstAndThen(predicate): InteractionBuilderImpl<I, D>
Combines 'first' and 'then'.
Parameters
- predicate: ((i) => boolean)
  The predicate to execute. If it returns true, the interaction is cancelled.
  - - (i): boolean
    - Parameters
      i: D
      Returns boolean
Returns InteractionBuilderImpl<I, D>
Implementation of InteractionBuilder.firstAndThen
- Defined in impl/interaction/InteractionBuilderImpl.ts:58

name

name(name): InteractionBuilderImpl<I, D>
It is recommanded to change the name of the customized user interaction with a unique name.
Parameters
- name: string
  The unique name of the customized user interaction.
Returns InteractionBuilderImpl<I, D>
Implementation of InteractionBuilder.name
- Defined in impl/interaction/InteractionBuilderImpl.ts:69

`Private` process

process(i, predicate?): void
Parameters
- i: I
- Optional predicate: ((i) => boolean)
  - - (i): boolean
    - Parameters
      i: D
      Returns boolean
Returns void
- Defined in impl/interaction/InteractionBuilderImpl.ts:92

then

then(predicate): InteractionBuilderImpl<I, D>
A predicate to execution just before each interaction update.
Parameters
- predicate: ((i) => boolean)
  The predicate to execute. If it returns true, the interaction is cancelled.
  - - (i): boolean
    - Parameters
      i: D
      Returns boolean
Returns InteractionBuilderImpl<I, D>
Implementation of InteractionBuilder.then
- Defined in impl/interaction/InteractionBuilderImpl.ts:53

Generated using TypeDoc