@thi.ng/proctext/api.d.ts

Extensible procedural text generation engine with dynamic, mutable state, indirection, randomizable & recursive variable expansions

import type { Fn, FnU, MaybePromise } from "@thi.ng/api";
import type { IRandom } from "@thi.ng/random";
export interface Var {
    opts: string[];
    history: string[];
}
export interface GeneratorContext {
    /**
     * Object of variables and their possible expansions (value options).
     */
    vars: Record<string, Var>;
    /**
     * Object of modifier functions to transform.
     */
    mods: Record<string, Fn<string, MaybePromise<string>>>;
    /**
     * PRNG to use for selection variable options (see {@link Var.opts}).
     */
    rnd: IRandom;
    /**
     * Max number of choices to record per variable. When picking a possible
     * value for resolving a variable, the generator attempts to pick values
     * which are different than the last N choices.
     *
     * @defaultValue 1
     */
    maxHist: number;
    /**
     * Max attempts to find a new unique choice for variable
     * expansions/resolution
     *
     * @defaultValue 10
     */
    maxTrials: number;
    /**
     * If given, variable references which cannot be resolved will be replaced
     * by this string. If undefined (default), throws an error when unable to
     * resolve a var.
     */
    missing?: string | FnU<string>;
}
//# sourceMappingURL=api.d.ts.map