ibm-cloud-sdk-core 4.3.2 → 4.3.4

package/sdk-test-utilities/node_modules/expect/build/index.d.ts

@@ -0,0 +1,370 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type {EqualsFunction} from '@jest/expect-utils';
+import type * as jestMatcherUtils from 'jest-matcher-utils';
+import {Tester} from '@jest/expect-utils';
+import {TesterContext} from '@jest/expect-utils';
+
+export declare abstract class AsymmetricMatcher<T>
+  implements AsymmetricMatcher_2
+{
+  protected sample: T;
+  protected inverse: boolean;
+  $$typeof: symbol;
+  constructor(sample: T, inverse?: boolean);
+  protected getMatcherContext(): MatcherContext;
+  abstract asymmetricMatch(other: unknown): boolean;
+  abstract toString(): string;
+  getExpectedType?(): string;
+  toAsymmetricMatcher?(): string;
+}
+
+declare type AsymmetricMatcher_2 = {
+  asymmetricMatch(other: unknown): boolean;
+  toString(): string;
+  getExpectedType?(): string;
+  toAsymmetricMatcher?(): string;
+};
+
+export declare interface AsymmetricMatchers {
+  any(sample: unknown): AsymmetricMatcher_2;
+  anything(): AsymmetricMatcher_2;
+  arrayContaining(sample: Array<unknown>): AsymmetricMatcher_2;
+  closeTo(sample: number, precision?: number): AsymmetricMatcher_2;
+  objectContaining(sample: Record<string, unknown>): AsymmetricMatcher_2;
+  stringContaining(sample: string): AsymmetricMatcher_2;
+  stringMatching(sample: string | RegExp): AsymmetricMatcher_2;
+}
+
+export declare type AsyncExpectationResult = Promise<SyncExpectationResult>;
+
+export declare interface BaseExpect {
+  assertions(numberOfAssertions: number): void;
+  addEqualityTesters(testers: Array<Tester>): void;
+  extend(matchers: MatchersObject): void;
+  extractExpectedAssertionsErrors(): ExpectedAssertionsErrors;
+  getState(): MatcherState;
+  hasAssertions(): void;
+  setState(state: Partial<MatcherState>): void;
+}
+
+export declare type Expect = {
+  <T = unknown>(actual: T): Matchers<void, T> &
+    Inverse<Matchers<void, T>> &
+    PromiseMatchers<T>;
+} & BaseExpect &
+  AsymmetricMatchers &
+  Inverse<Omit<AsymmetricMatchers, 'any' | 'anything'>>;
+
+declare const expect: Expect;
+export default expect;
+export {expect};
+
+export declare type ExpectationResult =
+  | SyncExpectationResult
+  | AsyncExpectationResult;
+
+declare type ExpectedAssertionsErrors = Array<{
+  actual: string | number;
+  error: Error;
+  expected: string;
+}>;
+
+declare type Inverse<Matchers> = {
+  /**
+   * Inverse next matcher. If you know how to test something, `.not` lets you test its opposite.
+   */
+  not: Matchers;
+};
+
+export declare class JestAssertionError extends Error {
+  matcherResult?: Omit<SyncExpectationResult, 'message'> & {
+    message: string;
+  };
+}
+
+export declare type MatcherContext = MatcherUtils & Readonly<MatcherState>;
+
+export declare type MatcherFunction<Expected extends Array<unknown> = []> =
+  MatcherFunctionWithContext<MatcherContext, Expected>;
+
+export declare type MatcherFunctionWithContext<
+  Context extends MatcherContext = MatcherContext,
+  Expected extends Array<any> = [] /** TODO should be: extends Array<unknown> = [] */,
+> = (
+  this: Context,
+  actual: unknown,
+  ...expected: Expected
+) => ExpectationResult;
+
+export declare interface Matchers<R extends void | Promise<void>, T = unknown> {
+  /**
+   * Ensures the last call to a mock function was provided specific args.
+   */
+  lastCalledWith(...expected: Array<unknown>): R;
+  /**
+   * Ensure that the last call to a mock function has returned a specified value.
+   */
+  lastReturnedWith(expected?: unknown): R;
+  /**
+   * Ensure that a mock function is called with specific arguments on an Nth call.
+   */
+  nthCalledWith(nth: number, ...expected: Array<unknown>): R;
+  /**
+   * Ensure that the nth call to a mock function has returned a specified value.
+   */
+  nthReturnedWith(nth: number, expected?: unknown): R;
+  /**
+   * Checks that a value is what you expect. It calls `Object.is` to compare values.
+   * Don't use `toBe` with floating-point numbers.
+   */
+  toBe(expected: unknown): R;
+  /**
+   * Ensures that a mock function is called.
+   */
+  toBeCalled(): R;
+  /**
+   * Ensures that a mock function is called an exact number of times.
+   */
+  toBeCalledTimes(expected: number): R;
+  /**
+   * Ensure that a mock function is called with specific arguments.
+   */
+  toBeCalledWith(...expected: Array<unknown>): R;
+  /**
+   * Using exact equality with floating point numbers is a bad idea.
+   * Rounding means that intuitive things fail.
+   * The default for `precision` is 2.
+   */
+  toBeCloseTo(expected: number, precision?: number): R;
+  /**
+   * Ensure that a variable is not undefined.
+   */
+  toBeDefined(): R;
+  /**
+   * When you don't care what a value is, you just want to
+   * ensure a value is false in a boolean context.
+   */
+  toBeFalsy(): R;
+  /**
+   * For comparing floating point numbers.
+   */
+  toBeGreaterThan(expected: number | bigint): R;
+  /**
+   * For comparing floating point numbers.
+   */
+  toBeGreaterThanOrEqual(expected: number | bigint): R;
+  /**
+   * Ensure that an object is an instance of a class.
+   * This matcher uses `instanceof` underneath.
+   */
+  toBeInstanceOf(expected: unknown): R;
+  /**
+   * For comparing floating point numbers.
+   */
+  toBeLessThan(expected: number | bigint): R;
+  /**
+   * For comparing floating point numbers.
+   */
+  toBeLessThanOrEqual(expected: number | bigint): R;
+  /**
+   * Used to check that a variable is NaN.
+   */
+  toBeNaN(): R;
+  /**
+   * This is the same as `.toBe(null)` but the error messages are a bit nicer.
+   * So use `.toBeNull()` when you want to check that something is null.
+   */
+  toBeNull(): R;
+  /**
+   * Use when you don't care what a value is, you just want to ensure a value
+   * is true in a boolean context. In JavaScript, there are six falsy values:
+   * `false`, `0`, `''`, `null`, `undefined`, and `NaN`. Everything else is truthy.
+   */
+  toBeTruthy(): R;
+  /**
+   * Used to check that a variable is undefined.
+   */
+  toBeUndefined(): R;
+  /**
+   * Used when you want to check that an item is in a list.
+   * For testing the items in the list, this uses `===`, a strict equality check.
+   */
+  toContain(expected: unknown): R;
+  /**
+   * Used when you want to check that an item is in a list.
+   * For testing the items in the list, this  matcher recursively checks the
+   * equality of all fields, rather than checking for object identity.
+   */
+  toContainEqual(expected: unknown): R;
+  /**
+   * Used when you want to check that two objects have the same value.
+   * This matcher recursively checks the equality of all fields, rather than checking for object identity.
+   */
+  toEqual(expected: unknown): R;
+  /**
+   * Ensures that a mock function is called.
+   */
+  toHaveBeenCalled(): R;
+  /**
+   * Ensures that a mock function is called an exact number of times.
+   */
+  toHaveBeenCalledTimes(expected: number): R;
+  /**
+   * Ensure that a mock function is called with specific arguments.
+   */
+  toHaveBeenCalledWith(...expected: Array<unknown>): R;
+  /**
+   * Ensure that a mock function is called with specific arguments on an Nth call.
+   */
+  toHaveBeenNthCalledWith(nth: number, ...expected: Array<unknown>): R;
+  /**
+   * If you have a mock function, you can use `.toHaveBeenLastCalledWith`
+   * to test what arguments it was last called with.
+   */
+  toHaveBeenLastCalledWith(...expected: Array<unknown>): R;
+  /**
+   * Use to test the specific value that a mock function last returned.
+   * If the last call to the mock function threw an error, then this matcher will fail
+   * no matter what value you provided as the expected return value.
+   */
+  toHaveLastReturnedWith(expected?: unknown): R;
+  /**
+   * Used to check that an object has a `.length` property
+   * and it is set to a certain numeric value.
+   */
+  toHaveLength(expected: number): R;
+  /**
+   * Use to test the specific value that a mock function returned for the nth call.
+   * If the nth call to the mock function threw an error, then this matcher will fail
+   * no matter what value you provided as the expected return value.
+   */
+  toHaveNthReturnedWith(nth: number, expected?: unknown): R;
+  /**
+   * Use to check if property at provided reference keyPath exists for an object.
+   * For checking deeply nested properties in an object you may use dot notation or an array containing
+   * the keyPath for deep references.
+   *
+   * Optionally, you can provide a value to check if it's equal to the value present at keyPath
+   * on the target object. This matcher uses 'deep equality' (like `toEqual()`) and recursively checks
+   * the equality of all fields.
+   *
+   * @example
+   *
+   * expect(houseForSale).toHaveProperty('kitchen.area', 20);
+   */
+  toHaveProperty(
+    expectedPath: string | Array<string>,
+    expectedValue?: unknown,
+  ): R;
+  /**
+   * Use to test that the mock function successfully returned (i.e., did not throw an error) at least one time
+   */
+  toHaveReturned(): R;
+  /**
+   * Use to ensure that a mock function returned successfully (i.e., did not throw an error) an exact number of times.
+   * Any calls to the mock function that throw an error are not counted toward the number of times the function returned.
+   */
+  toHaveReturnedTimes(expected: number): R;
+  /**
+   * Use to ensure that a mock function returned a specific value.
+   */
+  toHaveReturnedWith(expected?: unknown): R;
+  /**
+   * Check that a string matches a regular expression.
+   */
+  toMatch(expected: string | RegExp): R;
+  /**
+   * Used to check that a JavaScript object matches a subset of the properties of an object
+   */
+  toMatchObject(
+    expected: Record<string, unknown> | Array<Record<string, unknown>>,
+  ): R;
+  /**
+   * Ensure that a mock function has returned (as opposed to thrown) at least once.
+   */
+  toReturn(): R;
+  /**
+   * Ensure that a mock function has returned (as opposed to thrown) a specified number of times.
+   */
+  toReturnTimes(expected: number): R;
+  /**
+   * Ensure that a mock function has returned a specified value at least once.
+   */
+  toReturnWith(expected?: unknown): R;
+  /**
+   * Use to test that objects have the same types as well as structure.
+   */
+  toStrictEqual(expected: unknown): R;
+  /**
+   * Used to test that a function throws when it is called.
+   */
+  toThrow(expected?: unknown): R;
+  /**
+   * If you want to test that a specific error is thrown inside a function.
+   */
+  toThrowError(expected?: unknown): R;
+}
+
+declare type MatchersObject = {
+  [name: string]: RawMatcherFn;
+};
+
+export declare interface MatcherState {
+  assertionCalls: number;
+  currentConcurrentTestName?: () => string | undefined;
+  currentTestName?: string;
+  error?: Error;
+  expand?: boolean;
+  expectedAssertionsNumber: number | null;
+  expectedAssertionsNumberError?: Error;
+  isExpectingAssertions: boolean;
+  isExpectingAssertionsError?: Error;
+  isNot?: boolean;
+  numPassingAsserts: number;
+  promise?: string;
+  suppressedErrors: Array<Error>;
+  testPath?: string;
+}
+
+export declare interface MatcherUtils {
+  customTesters: Array<Tester>;
+  dontThrow(): void;
+  equals: EqualsFunction;
+  utils: typeof jestMatcherUtils & {
+    iterableEquality: Tester;
+    subsetEquality: Tester;
+  };
+}
+
+declare type PromiseMatchers<T = unknown> = {
+  /**
+   * Unwraps the reason of a rejected promise so any other matcher can be chained.
+   * If the promise is fulfilled the assertion fails.
+   */
+  rejects: Matchers<Promise<void>, T> & Inverse<Matchers<Promise<void>, T>>;
+  /**
+   * Unwraps the value of a fulfilled promise so any other matcher can be chained.
+   * If the promise is rejected the assertion fails.
+   */
+  resolves: Matchers<Promise<void>, T> & Inverse<Matchers<Promise<void>, T>>;
+};
+
+declare type RawMatcherFn<Context extends MatcherContext = MatcherContext> = {
+  (this: Context, actual: any, ...expected: Array<any>): ExpectationResult;
+};
+
+export declare type SyncExpectationResult = {
+  pass: boolean;
+  message(): string;
+};
+
+export {Tester};
+
+export {TesterContext};
+
+export {};