Functionseedcordv0.14.0

defineEffectGate

Builds an EffectGateEffectGate from a checkcheck and a commitcommit. checkcheck peeks and refuses by throwing, and commitcommit applies the side effect, running only once the whole gate set passes so a later refusal never commits. In an oror, a refusing arm's queued commit is rolled back. This is how CooldownCooldown peeks in checkcheck and charges the slot in commitcommit.

See also:defineGate, Gated, Cooldown

defineEffectGate<Name, Ctx>(
    name: Name,
    check: (ctx: Ctx) => void | Promise<void>,
    commit: (ctx: Ctx) => void | Promise<void>
): EffectGate<Ctx, Name>

defineEffectGate<Name, Ctx>(
    name: Name,
    check: (ctx: Ctx) => void | Promise<void>,
    commit: (ctx: Ctx) => void | Promise<void>
): EffectGate<Ctx, Name>

// an effect-gate factory that takes its own limit and closes over it
function UsesPerDay(max: number): EffectGate<GateContextBase, 'UsesPerDay'> {
    return defineEffectGate(
        'UsesPerDay',
        (ctx) => {
            // peek and refuse by throwing, do not mutate yet
            if (usedToday(ctx.user) >= max) throw new OutOfUsesNotice(max);
        },
        (ctx) => {
            // runs only after the whole gate set passes
            recordUse(ctx.user);
        }
    );
}

// an effect-gate factory that takes its own limit and closes over it
function UsesPerDay(max: number): EffectGate<GateContextBase, 'UsesPerDay'> {
    return defineEffectGate(
        'UsesPerDay',
        (ctx) => {
            // peek and refuse by throwing, do not mutate yet
            if (usedToday(ctx.user) >= max) throw new OutOfUsesNotice(max);
        },
        (ctx) => {
            // runs only after the whole gate set passes
            recordUse(ctx.user);
        }
    );
}

Name

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

Name

Name

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

Ctx

The context both checkcheck and commitcommit read, inferred from the ctxctx annotation.

Ctx

Ctx

The context both checkcheck and commitcommit read, inferred from the ctxctx annotation.

name

name: Name

name: Name

The gate's name, used in mismatch errors.

check

check: (ctx: Ctx) => void | Promise<void>

check: (ctx: Ctx) => void | Promise<void>

Peeks and refuses by throwing, without applying the side effect.

commit

commit: (ctx: Ctx) => void | Promise<void>

commit: (ctx: Ctx) => void | Promise<void>

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

Functionseedcordv0.14.0

defineEffectGate

See also:defineGate, Gated, Cooldown

defineEffectGate<Name, Ctx>(
    name: Name,
    check: (ctx: Ctx) => void | Promise<void>,
    commit: (ctx: Ctx) => void | Promise<void>
): EffectGate<Ctx, Name>

defineEffectGate<Name, Ctx>(
    name: Name,
    check: (ctx: Ctx) => void | Promise<void>,
    commit: (ctx: Ctx) => void | Promise<void>
): EffectGate<Ctx, Name>

// an effect-gate factory that takes its own limit and closes over it
function UsesPerDay(max: number): EffectGate<GateContextBase, 'UsesPerDay'> {
    return defineEffectGate(
        'UsesPerDay',
        (ctx) => {
            // peek and refuse by throwing, do not mutate yet
            if (usedToday(ctx.user) >= max) throw new OutOfUsesNotice(max);
        },
        (ctx) => {
            // runs only after the whole gate set passes
            recordUse(ctx.user);
        }
    );
}

// an effect-gate factory that takes its own limit and closes over it
function UsesPerDay(max: number): EffectGate<GateContextBase, 'UsesPerDay'> {
    return defineEffectGate(
        'UsesPerDay',
        (ctx) => {
            // peek and refuse by throwing, do not mutate yet
            if (usedToday(ctx.user) >= max) throw new OutOfUsesNotice(max);
        },
        (ctx) => {
            // runs only after the whole gate set passes
            recordUse(ctx.user);
        }
    );
}

Name

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

Name

Name

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

Ctx

The context both checkcheck and commitcommit read, inferred from the ctxctx annotation.

Ctx

Ctx

The context both checkcheck and commitcommit read, inferred from the ctxctx annotation.

name

name: Name

name: Name

The gate's name, used in mismatch errors.

check

check: (ctx: Ctx) => void | Promise<void>

check: (ctx: Ctx) => void | Promise<void>

Peeks and refuses by throwing, without applying the side effect.

commit

commit: (ctx: Ctx) => void | Promise<void>

commit: (ctx: Ctx) => void | Promise<void>

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