@assertive-ts/core/dist/lib/config/Config.d.ts

A type-safe fluent assertion library

import { Assertion } from "../Assertion";
/**
 * A plugin object that can be used to extend the `expect(..)` function.
 *
 * @param T the type the plugin is meant for
 * @param A the type of the assertion for `T`
 */
export interface Plugin<T, A extends Assertion<T>> {
    /**
     * The assertion `A` constructor the plugin adds
     */
    Assertion: new (actual: T) => A;
    /**
     * The position were the predicate will test to return the `Assertion` or not:
     * - `top`: Test before all primitives and object-related types.
     * - `bottom`: Test after all primitives and object-related types.
     */
    insertAt: "top" | "bottom";
    /**
     * The predicate that tests if the actual value should returnt and instance of
     * the plugin's `Assertion`.
     */
    predicate: (actual: unknown) => actual is T;
}
/**
 * A configuration class used to share a `config` instance. Useful to expose
 * methods that can change global settings.
 */
export declare class Config {
    private pluginSet;
    constructor();
    plugins(): ReadonlyArray<Plugin<unknown, Assertion<unknown>>>;
    addPlugin<T, A extends Assertion<T>>(plugin: Plugin<T, A>): void;
}
export declare const config: Config;