WebhookLog

Base class for subscribers that deliver their event to a Discord webhook.

Declare the url's environment variable with @WebhookUrl@WebhookUrl and implement reportreport. Url resolution, validation, sender reuse, and sending run in the base. When the variable is unset the reporter is skipped at registration with a boot warning.

abstract class WebhookLog<
    KeyOfSubscribers extends SubscriptionKey
> extends Subscriber<KeyOfSubscribers>

abstract class WebhookLog<
    KeyOfSubscribers extends SubscriptionKey
> extends Subscriber<KeyOfSubscribers>

Member visibility

Filter class members by access level.

constructor

Instantiates the subscriber with event data and core.

Subscriber(
    data: AllSubscriptions[KeyOfSubscribers],
    core: Core
)

Subscriber(
    data: AllSubscriptions[KeyOfSubscribers],
    core: Core
)

Parameter: data

The subscriber event data

Parameter: core

The core framework instance

Inherited from:Subscriber

Showing members with Protected visibility and higher.

Methods

execute()
report()

KeyOfSubscribers

The subscription key this reporter receives

KeyOfSubscribers extends SubscriptionKey

KeyOfSubscribers extends SubscriptionKey

core

protected readonly core: Core

protected readonly core: Core

Inherited from:Subscriber

data

protected readonly data: AllSubscriptions[KeyOfSubscribers]

protected readonly data: AllSubscriptions[KeyOfSubscribers]

Inherited from:Subscriber

logger

protected readonly logger: Logger

protected readonly logger: Logger

Inherited from:Subscriber

execute()

public async execute(): Promise<void>

public async execute(): Promise<void>

report()

Builds the message for one published event.

public abstract report(): WebhookReport | Promise<WebhookReport>

public abstract report(): WebhookReport | Promise<WebhookReport>