@n1k1t/mock-server/lib/src/client/helpers/expectations.d.ts

Powerful util to setup mocks over HTTP APIs

import type { TFunction } from '../../../types';
import type { ExtractExpectationContextValue, IExpectationSchemaContext, IExpectationSchemaInput, TExpectationOperatorLocation, TExpectationOperatorObjectLocation } from '../../expectations';
import type AndExpectationOperator from '../../expectations/operators/and.operator';
import type ExecExpectationOperator from '../../expectations/operators/exec.operator';
import type HasExpectationOperator from '../../expectations/operators/has.operator';
import type IfExpectationOperator from '../../expectations/operators/if.operator';
import type MergeExpectationOperator from '../../expectations/operators/merge.operator';
import type NotExpectationOperator from '../../expectations/operators/not.operator';
import type OrExpectationOperator from '../../expectations/operators/or.operator';
import type RemoveExpectationOperator from '../../expectations/operators/remove.operator';
import type SetExpectationOperator from '../../expectations/operators/set.operator';
import type SwitchExpectationOperator from '../../expectations/operators/switch.operator';
export interface ICompiledExpectationOperators<TInput extends IExpectationSchemaInput, TContext extends IExpectationSchemaContext<TInput> = IExpectationSchemaContext<TInput>> {
    not<S extends NotExpectationOperator<TContext, TExpectationOperatorLocation, any>['TSchema']>(command: S): {
        $not: S;
    };
    and<S extends AndExpectationOperator<TContext, TExpectationOperatorLocation, any>['TSchema']>(command: S): {
        $and: S;
    };
    or<S extends OrExpectationOperator<TContext, TExpectationOperatorLocation, any>['TSchema']>(command: S): {
        $or: S;
    };
    exec<S extends ExecExpectationOperator<TContext>['TSchema']>(command: S): {
        $exec: S;
    };
    if<S extends IfExpectationOperator<TContext, TExpectationOperatorLocation, any>['TSchema']>(command: S): {
        $if: S;
    };
    switch<K extends TExpectationOperatorLocation, S extends SwitchExpectationOperator<TContext, TExpectationOperatorLocation, void, TExpectationOperatorLocation, any>['TSchema']>(location: K, command: Omit<S, '$location'>): {
        $switch: S & {
            $location: K;
        };
    };
    switch<K extends TExpectationOperatorLocation, U extends '$path' | '$exec', Q extends U extends '$exec' ? NonNullable<SwitchExpectationOperator<TContext, K>['TSchema']['$exec']> : string, V extends Q extends TFunction<infer R, any[]> ? NonNullable<R> extends (string | number) ? NonNullable<R> : void : Q extends string ? ExtractExpectationContextValue<TContext, K, Q> : void, S extends SwitchExpectationOperator<TContext, K, V, TExpectationOperatorLocation, any>['TSchema']>(location: K, using: U, value: Q, command: Omit<S, '$location' | '$path' | '$exec'>): {
        $switch: S & {
            $location: K;
            $exec: Q;
        };
    };
    has<K extends TExpectationOperatorLocation, S extends HasExpectationOperator<TContext, K>['TSchema']>(location: K, command?: Omit<S, '$location'>): {
        $has: S & {
            $location: K;
        };
    };
    has<K extends TExpectationOperatorLocation, U extends '$path' | '$jsonPath', Q extends string, V extends U extends '$path' ? ExtractExpectationContextValue<TContext, K, Q> : unknown, S extends HasExpectationOperator<TContext, K, V>['TSchema']>(location: K, using: U, value: Q, command?: Omit<S, '$location' | '$path' | '$jsonPath'>): {
        $has: S & {
            $location: any;
            $path?: string;
            $jsonPath?: string;
        };
    };
    set<K extends TExpectationOperatorLocation, S extends SetExpectationOperator<TContext, K>['TSchema']>(location: K, command: Omit<S, '$location'>): {
        $set: S & {
            $location: K;
        };
    };
    set<K extends TExpectationOperatorLocation, U extends '$path' | '$jsonPath', Q extends string, V extends U extends '$path' ? ExtractExpectationContextValue<TContext, K, Q> : unknown, S extends SetExpectationOperator<TContext, K, V>['TSchema']>(location: K, using: U, value: Q, command: Omit<S, '$location' | '$path' | '$jsonPath'>): {
        $set: S & {
            $location: K;
            $path?: string;
            $jsonPath?: string;
        };
    };
    merge<K extends TExpectationOperatorObjectLocation, S extends MergeExpectationOperator<TContext, K>['TSchema']>(location: K, command: Omit<S, '$location'>): {
        $merge: S & {
            $location: K;
        };
    };
    merge<K extends TExpectationOperatorObjectLocation, U extends '$path' | '$jsonPath', Q extends string, V extends U extends '$path' ? ExtractExpectationContextValue<TContext, K, Q> : unknown, S extends MergeExpectationOperator<TContext, K, V>['TSchema']>(location: K, using: U, value: Q, command: Omit<S, '$location' | '$path' | '$jsonPath'>): {
        $merge: S & {
            $location: K;
            $path?: string;
            $jsonPath?: string;
        };
    };
    remove<K extends TExpectationOperatorLocation, S extends RemoveExpectationOperator<TContext, K>['TSchema']>(location: K, command: Omit<S, '$location'>): {
        $remove: S & {
            $location: K;
        };
    };
    remove<K extends TExpectationOperatorLocation, U extends '$path' | '$jsonPath'>(location: K, using: U, value: string): {
        $remove: {
            $location: K;
            $path?: string;
            $jsonPath?: string;
        };
    };
}
export declare const compileExpectationOperators: <TInput extends IExpectationSchemaInput, TContext extends IExpectationSchemaContext<TInput> = IExpectationSchemaContext<TInput>>() => ICompiledExpectationOperators<TContext>;
//# sourceMappingURL=expectations.d.ts.map