Interfaceseedcordv0.13.0

EffectGate

A gate that carries a side effect, split so the effect fires only once the gate is the one that let the request through. checkcheck peeks and refuses, commitcommit applies the effect after the whole gate set passes. CooldownCooldown is the catalog gate that returns one. Build one with defineEffectGatedefineEffectGate.

See also:defineEffectGate

interface EffectGate<
    Ctx extends GateContextBase = GateContext,
    Name extends string = string
> extends Gate<Ctx, Name>

interface EffectGate<
    Ctx extends GateContextBase = GateContext,
    Name extends string = string
> extends Gate<Ctx, Name>

// a factory returning a typed effect gate
function MyEffectGate(): EffectGate<GateContextBase, 'MyEffectGate'> {
    return defineEffectGate(
        'MyEffectGate',
        (ctx) => {
            if (shouldRefuse(ctx)) throw new MyNotice();
        },
        (ctx) => {
            applyMyEffect(ctx);
        }
    );
}

// a factory returning a typed effect gate
function MyEffectGate(): EffectGate<GateContextBase, 'MyEffectGate'> {
    return defineEffectGate(
        'MyEffectGate',
        (ctx) => {
            if (shouldRefuse(ctx)) throw new MyNotice();
        },
        (ctx) => {
            applyMyEffect(ctx);
        }
    );
}

Methods

check()
commit()

Ctx

The context the gate requires, so reading a field absent on a handler's context is a compile error.

Ctx extends GateContextBase = GateContext

Ctx extends GateContextBase = GateContext

Name

The gate's name captured as a literal, so a mismatch error can name the gate.

Name extends string = string

Name extends string = string

[GateBrand]

Phantom brand that marks a real gate, you never set or read it.

readonly [GateBrand]: true

readonly [GateBrand]: true

Inherited from:Gate

name

The gate's name, surfaced in a mismatch error and joined by the combinators.

readonly name: Name

readonly name: Name

Inherited from:Gate

check()

Reads the context and refuses by throwing a Notice or a Silence, or passes by resolving.

async check(ctx: Ctx): Promise<void>

async check(ctx: Ctx): Promise<void>

Inherited from:Gate

commit()

Applies the side effect, run only after the whole gate set passes.

async commit(ctx: Ctx): Promise<void>

async commit(ctx: Ctx): Promise<void>

Interfaceseedcordv0.13.0

EffectGate

See also:defineEffectGate

interface EffectGate<
    Ctx extends GateContextBase = GateContext,
    Name extends string = string
> extends Gate<Ctx, Name>

interface EffectGate<
    Ctx extends GateContextBase = GateContext,
    Name extends string = string
> extends Gate<Ctx, Name>

// a factory returning a typed effect gate
function MyEffectGate(): EffectGate<GateContextBase, 'MyEffectGate'> {
    return defineEffectGate(
        'MyEffectGate',
        (ctx) => {
            if (shouldRefuse(ctx)) throw new MyNotice();
        },
        (ctx) => {
            applyMyEffect(ctx);
        }
    );
}

// a factory returning a typed effect gate
function MyEffectGate(): EffectGate<GateContextBase, 'MyEffectGate'> {
    return defineEffectGate(
        'MyEffectGate',
        (ctx) => {
            if (shouldRefuse(ctx)) throw new MyNotice();
        },
        (ctx) => {
            applyMyEffect(ctx);
        }
    );
}

Properties

[GateBrand]
name

Methods

check()
commit()

Ctx

The context the gate requires, so reading a field absent on a handler's context is a compile error.

Ctx extends GateContextBase = GateContext

Ctx extends GateContextBase = GateContext

Name

The gate's name captured as a literal, so a mismatch error can name the gate.

Name extends string = string

Name extends string = string

[GateBrand]

Phantom brand that marks a real gate, you never set or read it.

readonly [GateBrand]: true

readonly [GateBrand]: true

Inherited from:Gate

name

The gate's name, surfaced in a mismatch error and joined by the combinators.

readonly name: Name

readonly name: Name

Inherited from:Gate

check()

Reads the context and refuses by throwing a Notice or a Silence, or passes by resolving.

async check(ctx: Ctx): Promise<void>

async check(ctx: Ctx): Promise<void>

Inherited from:Gate

commit()

Applies the side effect, run only after the whole gate set passes.

async commit(ctx: Ctx): Promise<void>

async commit(ctx: Ctx): Promise<void>