Classkitv0.1.1

Fault

A generic fault you throw after catching an error you do not have a specific message for.

The user sees a fixed generic reply with the tracking uuid, never the cause. reportreport defaults to truetrue, so the framework logs it and publishes it to the handledExceptionhandledException bus. Pass report: falsereport: false to show the generic reply without the bus publish. The original error is stored as the standard causecause, so the real stack reaches the webhook. For a fault the user should see a real message, subclass NoticeNotice and write your own renderrender instead.

The framework also renders this for an unhandled throw, where it points the user at ctx.developerUsernamectx.developerUsername.

class Fault extends Notice

class Fault extends Notice

import { Fault } from '@seedcord/kit';

try {
    await db.write(record);
} catch (cause) {
    // user sees the generic reply with the uuid, the real error rides along as cause for the webhook
    throw new Fault({ cause });

    // pass report: false to show the same reply without publishing to the handledException bus
    // throw new Fault({ cause, report: false });
}

import { Fault } from '@seedcord/kit';

try {
    await db.write(record);
} catch (cause) {
    // user sees the generic reply with the uuid, the real error rides along as cause for the webhook
    throw new Fault({ cause });

    // pass report: false to show the same reply without publishing to the handledException bus
    // throw new Fault({ cause, report: false });
}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the FaultFault class

Fault(options?: {
    cause?: unknown;
    report?: boolean;
})

Fault(options?: {
    cause?: unknown;
    report?: boolean;
})

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.

ephemeral: boolean;

ephemeral: boolean;

Inherited from:Notice

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.

report: boolean;

report: boolean;

Inherited from:Notice

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.

summary: string;

summary: string;

Inherited from:Notice

render()

public render(ctx: RenderContext): ReplyResponse

public render(ctx: RenderContext): ReplyResponse

Classkitv0.1.1

Fault

A generic fault you throw after catching an error you do not have a specific message for.

The framework also renders this for an unhandled throw, where it points the user at ctx.developerUsernamectx.developerUsername.

class Fault extends Notice

class Fault extends Notice

import { Fault } from '@seedcord/kit';

try {
    await db.write(record);
} catch (cause) {
    // user sees the generic reply with the uuid, the real error rides along as cause for the webhook
    throw new Fault({ cause });

    // pass report: false to show the same reply without publishing to the handledException bus
    // throw new Fault({ cause, report: false });
}

import { Fault } from '@seedcord/kit';

try {
    await db.write(record);
} catch (cause) {
    // user sees the generic reply with the uuid, the real error rides along as cause for the webhook
    throw new Fault({ cause });

    // pass report: false to show the same reply without publishing to the handledException bus
    // throw new Fault({ cause, report: false });
}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the FaultFault class

Fault(options?: {
    cause?: unknown;
    report?: boolean;
})

Fault(options?: {
    cause?: unknown;
    report?: boolean;
})

Showing members with Protected visibility and higher.

Properties

ephemeral
report
summary

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.

ephemeral: boolean;

ephemeral: boolean;

Inherited from:Notice

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.

report: boolean;

report: boolean;

Inherited from:Notice

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.

summary: string;

summary: string;

Inherited from:Notice

render()

public render(ctx: RenderContext): ReplyResponse

public render(ctx: RenderContext): ReplyResponse