Classcorev0.1.0-next.5

RepliableHandler

Shared base the repliable handlers on both transports extend. Defines the reply members over the sender the transport builds.

abstract class RepliableHandler<
    Event,
    TCore extends CoreBase,
    TMessage extends { id: string },
    TSender extends BaseReplySender<TMessage>
> extends BaseHandler<Event, TCore>

abstract class RepliableHandler<
    Event,
    TCore extends CoreBase,
    TMessage extends { id: string },
    TSender extends BaseReplySender<TMessage>
> extends BaseHandler<Event, TCore>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the RepliableHandlerRepliableHandler class

protected RepliableHandler(
    event: Event,
    core: TCore,
    dispatch?: DispatchContext
)

protected RepliableHandler(
    event: Event,
    core: TCore,
    dispatch?: DispatchContext
)

Showing members with Protected visibility and higher.

Methods

buildSender()
defer()
delete()
edit()
execute()
followUp()
reply()
send()

Event

The repliable interaction type this handler processes

Event

Event

TCore

The transport's Core

TCore extends CoreBase

TCore extends CoreBase

TMessage

The transport's created-message lens

TMessage extends { id: string; }

TMessage extends { id: string; }

TSender

The transport's reply sender

TSender extends BaseReplySender<TMessage>

TSender extends BaseReplySender<TMessage>

core

readonly core: TCore

readonly core: TCore

Inherited from:BaseHandler

optional

dispatch

protected readonly dispatch: DispatchContext | undefined

protected readonly dispatch: DispatchContext | undefined

Inherited from:BaseHandler

event

protected readonly event: Event

protected readonly event: Event

Inherited from:BaseHandler

id

public id: string

public id: string

logger

protected readonly logger: Logger

protected readonly logger: Logger

Inherited from:BaseHandler

routeId

protected readonly routeId: string

protected readonly routeId: string

sender

protected readonly sender: TSender

protected readonly sender: TSender

buildSender()

protected abstract buildSender(
    event: Event,
    core: TCore,
    routeId: string
): TSender

protected abstract buildSender(
    event: Event,
    core: TCore,
    routeId: string
): TSender

defer()

Show a "thinking" placeholder, then fill it later with editedit.

protected async defer(opts?: DeferOpts): Promise<void>

protected async defer(opts?: DeferOpts): Promise<void>

delete()

Delete the initial reply or deferred placeholder. Pass a target to delete a message a prior send returned.

protected async delete(target?: TMessage): Promise<void>

protected async delete(target?: TMessage): Promise<void>

edit()

Rewrite the initial reply or deferred placeholder. The targeted form rewrites a message a prior send returned.

Overloads

Overload 1Overload 2

protected async edit(
    response: ReplyResponse | string
): Promise<TMessage>

protected async edit(
    response: ReplyResponse | string
): Promise<TMessage>

protected async edit(
    target: TMessage,
    response: ReplyResponse | string
): Promise<TMessage>

protected async edit(
    target: TMessage,
    response: ReplyResponse | string
): Promise<TMessage>

execute()

Holds the main logic of your handler. The dispatcher calls it after the handler's gates pass, so a gate that refuses stops execute()execute() from running.

abstract async execute(): Promise<void>

abstract async execute(): Promise<void>

Inherited from:BaseHandler

followUp()

Send a new message once the interaction is acknowledged.

protected async followUp(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

protected async followUp(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

reply()

Send the initial response, exactly once.

protected async reply(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

protected async reply(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

send()

Routes to reply, followUp, or edit based on the current ack state.

protected async send(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

protected async send(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

Classcorev0.1.0-next.5

RepliableHandler

Shared base the repliable handlers on both transports extend. Defines the reply members over the sender the transport builds.

abstract class RepliableHandler<
    Event,
    TCore extends CoreBase,
    TMessage extends { id: string },
    TSender extends BaseReplySender<TMessage>
> extends BaseHandler<Event, TCore>

abstract class RepliableHandler<
    Event,
    TCore extends CoreBase,
    TMessage extends { id: string },
    TSender extends BaseReplySender<TMessage>
> extends BaseHandler<Event, TCore>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the RepliableHandlerRepliableHandler class

protected RepliableHandler(
    event: Event,
    core: TCore,
    dispatch?: DispatchContext
)

protected RepliableHandler(
    event: Event,
    core: TCore,
    dispatch?: DispatchContext
)

Showing members with Protected visibility and higher.

Properties

core
dispatch
event
id
logger
routeId
sender

Methods

buildSender()
defer()
delete()
edit()
execute()
followUp()
reply()
send()

Event

The repliable interaction type this handler processes

Event

Event

TCore

The transport's Core

TCore extends CoreBase

TCore extends CoreBase

TMessage

The transport's created-message lens

TMessage extends { id: string; }

TMessage extends { id: string; }

TSender

The transport's reply sender

TSender extends BaseReplySender<TMessage>

TSender extends BaseReplySender<TMessage>

core

readonly core: TCore

readonly core: TCore

Inherited from:BaseHandler

optional

dispatch

protected readonly dispatch: DispatchContext | undefined

protected readonly dispatch: DispatchContext | undefined

Inherited from:BaseHandler

event

protected readonly event: Event

protected readonly event: Event

Inherited from:BaseHandler

id

public id: string

public id: string

logger

protected readonly logger: Logger

protected readonly logger: Logger

Inherited from:BaseHandler

routeId

protected readonly routeId: string

protected readonly routeId: string

sender

protected readonly sender: TSender

protected readonly sender: TSender

buildSender()

protected abstract buildSender(
    event: Event,
    core: TCore,
    routeId: string
): TSender

protected abstract buildSender(
    event: Event,
    core: TCore,
    routeId: string
): TSender

defer()

Show a "thinking" placeholder, then fill it later with editedit.

protected async defer(opts?: DeferOpts): Promise<void>

protected async defer(opts?: DeferOpts): Promise<void>

delete()

Delete the initial reply or deferred placeholder. Pass a target to delete a message a prior send returned.

protected async delete(target?: TMessage): Promise<void>

protected async delete(target?: TMessage): Promise<void>

edit()

Rewrite the initial reply or deferred placeholder. The targeted form rewrites a message a prior send returned.

Overloads

Overload 1Overload 2

protected async edit(
    response: ReplyResponse | string
): Promise<TMessage>

protected async edit(
    response: ReplyResponse | string
): Promise<TMessage>

protected async edit(
    target: TMessage,
    response: ReplyResponse | string
): Promise<TMessage>

protected async edit(
    target: TMessage,
    response: ReplyResponse | string
): Promise<TMessage>

execute()

Holds the main logic of your handler. The dispatcher calls it after the handler's gates pass, so a gate that refuses stops execute()execute() from running.

abstract async execute(): Promise<void>

abstract async execute(): Promise<void>

Inherited from:BaseHandler

followUp()

Send a new message once the interaction is acknowledged.

protected async followUp(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

protected async followUp(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

reply()

Send the initial response, exactly once.

protected async reply(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

protected async reply(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

send()

Routes to reply, followUp, or edit based on the current ack state.

protected async send(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>

protected async send(
    response: ReplyResponse | string,
    opts?: SendOpts
): Promise<TMessage>