@sigiljs/sigil/dist/route/modifier/attach-modifier-context.d.ts

TypeScript-first Node.js HTTP framework offering schema-driven routing, modifier-based middleware, plugin extensibility, and flexible response templating

import { ModifierConstructor } from '..';
import { $SigilInternalModifierAPI } from './modifier.types';
import { DebugOptions } from '../../sigil/types';
/**
 * Options provided to plugin context for internal framework APIs.
 */
interface Options {
    /**
     * Internal API
     */
    sigilApi: $SigilInternalModifierAPI | undefined;
    /**
     * Debug options
     */
    debugOpts: Partial<DebugOptions>;
}
/**
 * Attaches internal Sigil framework context to a plugin prototype.
 *
 * @param modifier constructor of the Sigil modifier to augment.
 * @param opts internal context options supplied by the framework.
 */
export default function attachModifierContext(modifier: ModifierConstructor<any>, opts: Options): void;
export {};