Classcorev0.4.1

BaseReplySender

Tracks acknowledgement state and throws a translated SeedcordError on an illegal verb before any transport call. Every verb runs the legality check, calls the transport's wire writer, then updates the state and the ack trace. Each transport binds TMessage to its own created-message type and supplies the writers.

abstract class BaseReplySender<
    TMessage extends { id: string },
    TNative = never
>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the BaseReplySender class

protected BaseReplySender(
    routeId: string,
    telemetry: ReplyTelemetry,
    initialState?: AckState
)

Showing members with Protected visibility and higher.

TMessage

TMessage extends { id: string; }

TNative

TNative = never

routeId

protected readonly routeId: string

defer()

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

deferUpdate()

public async deferUpdate(): Promise<void>

delete()

public async delete(): Promise<void>

edit()

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

followUp()

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

remember()

protected remember(created: TMessage): TMessage

reply()

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

send()

Routes to the verb the current ack state permits. Every state has a route, so the illegal-ack throw is unreachable.

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

serialize()

protected serialize(
    response: ReplyResponse<TNative> | string
): SerializedReply<TNative>

update()

After a deferUpdate the state stays deferred-update. Calling this again rewrites. The returned message is the source message, editable only through a bare update or edit. A targeted edit or delete of it throws the foreign-target error.

public async update(
    response: ReplyResponse<TNative> | string
): Promise<TMessage>

writeDefer()

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

writeDeferUpdate()

protected abstract async writeDeferUpdate(): Promise<void>

writeDeleteOriginal()

protected abstract async writeDeleteOriginal(): Promise<void>

writeDeleteTarget()

protected abstract async writeDeleteTarget(
    targetId: string
): Promise<void>

writeEditOriginal()

protected abstract async writeEditOriginal(
    response: ReplyResponse<TNative> | string
): Promise<TMessage>

writeEditTarget()

protected abstract async writeEditTarget(
    targetId: string,
    response: ReplyResponse<TNative> | string
): Promise<TMessage>

writeFollowUp()

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

writeReply()

protected abstract async writeReply(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage | undefined>

writeUpdate()

protected abstract async writeUpdate(
    response: ReplyResponse<TNative> | string
): Promise<TMessage | undefined>

Classcorev0.4.1

BaseReplySender

abstract class BaseReplySender<
    TMessage extends { id: string },
    TNative = never
>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the BaseReplySender class

protected BaseReplySender(
    routeId: string,
    telemetry: ReplyTelemetry,
    initialState?: AckState
)

Showing members with Protected visibility and higher.

TMessage

TMessage extends { id: string; }

TNative

TNative = never

routeId

protected readonly routeId: string

defer()

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

deferUpdate()

public async deferUpdate(): Promise<void>

delete()

public async delete(): Promise<void>

edit()

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

followUp()

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

remember()

protected remember(created: TMessage): TMessage

reply()

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

send()

Routes to the verb the current ack state permits. Every state has a route, so the illegal-ack throw is unreachable.

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

serialize()

protected serialize(
    response: ReplyResponse<TNative> | string
): SerializedReply<TNative>

update()

public async update(
    response: ReplyResponse<TNative> | string
): Promise<TMessage>

writeDefer()

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

writeDeferUpdate()

protected abstract async writeDeferUpdate(): Promise<void>

writeDeleteOriginal()

protected abstract async writeDeleteOriginal(): Promise<void>

writeDeleteTarget()

protected abstract async writeDeleteTarget(
    targetId: string
): Promise<void>

writeEditOriginal()

protected abstract async writeEditOriginal(
    response: ReplyResponse<TNative> | string
): Promise<TMessage>

writeEditTarget()

protected abstract async writeEditTarget(
    targetId: string,
    response: ReplyResponse<TNative> | string
): Promise<TMessage>

writeFollowUp()

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

writeReply()

protected abstract async writeReply(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage | undefined>

writeUpdate()

protected abstract async writeUpdate(
    response: ReplyResponse<TNative> | string
): Promise<TMessage | undefined>

constructor

Properties

Methods

TMessage

TNative

routeId

defer()

deferUpdate()

delete()

edit()

followUp()

guardModalSource()

remember()

reply()

send()

serialize()

showModal()

update()

writeDefer()

writeDeferUpdate()

writeDeleteOriginal()

writeDeleteTarget()

writeEditOriginal()

writeEditTarget()

writeFollowUp()

writeModal()

writeReply()

writeUpdate()

constructor

Properties

Methods

TMessage

TNative

routeId

defer()

deferUpdate()

delete()

edit()

followUp()

guardModalSource()

remember()

reply()

send()

serialize()

showModal()

update()

writeDefer()

writeDeferUpdate()

writeDeleteOriginal()

writeDeleteTarget()

writeEditOriginal()

writeEditTarget()

writeFollowUp()

writeModal()

writeReply()

writeUpdate()