Classkitv0.1.1

Notice

Base class for a user-facing refusal or a reported fault.

Throw a NoticeNotice to stop a handler and reply to the user. The framework catches it at the controller boundary and renders renderrender, which always decides what the user sees. With reportreport false that render is all that happens. With reportreport true the framework also logs the fault and publishes it to the handledExceptionhandledException bus. A raw, non-Notice throw shows the generic message.

abstract class Notice extends Error

abstract class Notice extends Error

import { Notice, BuilderComponent, type RenderContext, type ReplyResponse } from 'seedcord';
import { TextDisplayBuilder } from 'discord.js';

// reading `.component` applies the configured bot color to the container accent
class TooPoorCard extends BuilderComponent<'container'> {
    constructor(balance: number) {
        super('container');
        this.instance.addTextDisplayComponents(
            new TextDisplayBuilder().setContent(`### Insufficient balance\nYou need more than ${balance} coins.`)
        );
    }
}

class TooPoor extends Notice {
    constructor(private readonly balance: number) {
        super(`balance ${balance} is below the cost`);
    }

    render(_ctx: RenderContext): ReplyResponse {
        return { components: [new TooPoorCard(this.balance).component] };
    }
}

// in a handler, throwing stops the handler and replies with render(ctx)
if (wallet.balance < cost) throw new TooPoor(wallet.balance);

import { Notice, BuilderComponent, type RenderContext, type ReplyResponse } from 'seedcord';
import { TextDisplayBuilder } from 'discord.js';

// reading `.component` applies the configured bot color to the container accent
class TooPoorCard extends BuilderComponent<'container'> {
    constructor(balance: number) {
        super('container');
        this.instance.addTextDisplayComponents(
            new TextDisplayBuilder().setContent(`### Insufficient balance\nYou need more than ${balance} coins.`)
        );
    }
}

class TooPoor extends Notice {
    constructor(private readonly balance: number) {
        super(`balance ${balance} is below the cost`);
    }

    render(_ctx: RenderContext): ReplyResponse {
        return { components: [new TooPoorCard(this.balance).component] };
    }
}

// in a handler, throwing stops the handler and replies with render(ctx)
if (wallet.balance < cost) throw new TooPoor(wallet.balance);

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the NoticeNotice class

protected Notice(message: string, options?: ErrorOptions)

protected Notice(message: string, options?: ErrorOptions)

Showing members with Protected visibility and higher.

Methods

render()

ephemeral

Whether the reply is ephemeral, so only the invoking user sees it. Set it false for a refusal the whole channel should see.

public ephemeral: boolean

public ephemeral: boolean

Default:truetrue

report

Whether this denial is a reported fault. True also logs it and publishes it to the handledExceptionhandledException bus. The user always sees renderrender either way.

public report: boolean

public report: boolean

Default:falsefalse

optional

summary

A short one-line reason. When every arm of an oror gate refuses and each refusal sets this, oror lists them instead of showing a neutral message.

public summary: string

public summary: string

render()

Builds what the user sees. Called fresh each time the denial is shown, so the builders are new and the bot color resolves at render time rather than at construction time.

public abstract render(ctx: RenderContext): ReplyResponse

public abstract render(ctx: RenderContext): ReplyResponse