earljs/dist/plugins/createPlugin.d.ts

Ergonomic, modern and type-safe assertion library

import { SmartEqRule } from '.';
import { PluginConfig } from './types';
/**
 * Used to create a new EarlJS plugin and preserve its types for declaration merging.
 *
 * @example
 * ```ts
 * const plugin = createPlugin({
 *   // your matchers, validators, and smartEqRules
 * })
 *
 * declare module 'earljs' {
 *   interface Expect extends createPlugin.MatchersOf<typeof plugin> {}
 *   interface Expectation<_> extends createPlugin.ValidatorsOf<typeof plugin> {}
 *   interface SmartEqRules extends createPlugin.SmartEqRulesOf<typeof plugin> {}
 * }
 * ```
 */
export declare function createPlugin<TConfig extends PluginConfig>(config: TConfig): TConfig;
export declare namespace createPlugin {
    type MatchersOf<TPlugin extends PluginConfig> = TPlugin['matchers'];
    type ValidatorsOf<TPlugin extends PluginConfig> = TPlugin['validators'];
    type SmartEqRulesOf<TPlugin extends PluginConfig> = TPlugin['smartEqRules'] extends any[] ? 'Error: smartEqRules must be dictionary with unique keys for declaration merging' : __OmitRuleForUnknown<Exclude<TPlugin['smartEqRules'], undefined | readonly any[]>>;
}
export declare type __OmitRuleForUnknown<TRules extends Record<string, SmartEqRule<never, never>>> = {
    [P in keyof TRules as TRules[P] extends SmartEqRule<unknown, unknown> ? never : P]: TRules[P];
};