Function stub

Returns (stub?: RecursivePartial<T>) => T

Returns {
    create(): (stub?: RecursivePartial<T>) => T;
    with(
        init:
            | RecursivePartial<T>
            | (stub?: RecursivePartial<T>) => RecursivePartial<T>,
    ): { with(init: RecursivePartial<T> | ((stub?: RecursivePartial<T> | undefined) => RecursivePartial<T>)): ...; create(): (stub?: RecursivePartial<...> | undefined) => T; };
}

• create:function

  • create(): (stub?: RecursivePartial<T>) => T

    Creates the resulting stub function.

    Returns (stub?: RecursivePartial<T>) => T

• with:function

  • with(
        init:
            | RecursivePartial<T>
            | (stub?: RecursivePartial<T>) => RecursivePartial<T>,
    ): { with(init: RecursivePartial<T> | ((stub?: RecursivePartial<T> | undefined) => RecursivePartial<T>)): ...; create(): (stub?: RecursivePartial<...> | undefined) => T; }

    Adds an init object or handler to the builder.

    If init is an object, it will be merged with the stub object. If init is a function, it will be called with the stub object.

    Parameters

    • init: RecursivePartial<T> | (stub?: RecursivePartial<T>) => RecursivePartial<T>

    Returns { with(init: RecursivePartial<T> | ((stub?: RecursivePartial<T> | undefined) => RecursivePartial<T>)): ...; create(): (stub?: RecursivePartial<...> | undefined) => T; }

    The builder instance.

const b = stub.builder<{ a: number; b: string }>({ a: 1 }).with({ b: 'b' }).create()
b({ a: 2 }) // { a: 2, b: 'b' }
Copy