krl-stdlib/dist/KrlCtx.d.ts

Standard library for KRL

import { PicoEvent, PicoQuery, RulesetContext } from "pico-framework";
import * as krl from "./krl";
import { KrlLogger } from "./KrlLogger";
export interface CurrentPicoEvent extends PicoEvent {
    eid: string;
}
export interface CurrentPicoQuery extends PicoQuery {
    qid: string;
}
export interface Directive {
    type: "directive";
    name: string;
    options: {
        [name: string]: any;
    };
    meta: {
        rid: string;
        rule_name: string | null;
        txnId: string | null;
    };
}
export interface PicoLogEntry {
    level: string;
    time: string;
    txnId?: string;
}
export interface KrlCtx {
    rsCtx: RulesetContext;
    log: KrlLogger;
    getPicoLogs(): Promise<PicoLogEntry[]>;
    getEvent(): CurrentPicoEvent | null;
    setEvent(event: CurrentPicoEvent | null): void;
    setCurrentRuleName(ruleName: string | null): void;
    getCurrentRuleName(): string | null;
    getQuery(): CurrentPicoQuery | null;
    setQuery(query: CurrentPicoQuery | null): void;
    module(domain: string): krl.Module | null;
    configure(name: string, dflt: any): any;
    useModule(rid: string, alias?: string | null, configure?: {
        [name: string]: any;
    }): Promise<void> | void;
    addDirective(name: string, options: {
        [name: string]: any;
    }): Directive;
    drainDirectives(): Directive[];
    krl: typeof krl;
}