Type alias Test<Value>

Test<Value>: {
    given: string;
    must: string;
    received: (() => MaybePromise<Value>);
    wanted: (() => MaybePromise<Value>);
}

Object that describes a test.

Example

const test: Test<number> = {
given: "a number",
must: "make it double",
received: () => double(2),
wanted: () => 4,
};

Type Parameters

  • Value = unknown

Type declaration

  • Readonly given: string

    Description of the given value.

  • Readonly must: string

    Description of the wanted value.

  • Readonly received: (() => MaybePromise<Value>)
      • (): MaybePromise<Value>
      • Function that returns a value being tested.

        Returns MaybePromise<Value>

  • Readonly wanted: (() => MaybePromise<Value>)
      • (): MaybePromise<Value>
      • Functions that returns the expected value.

        Returns MaybePromise<Value>