@nevware21/tripwire - v0.1.7
    Preparing search index...

    Interface IIsTypeOp<R>

    Represents an interface for operations to assert the type of a value.

    interface IIsTypeOp<R> {
        array: AssertFn<R>;
        boolean: AssertFn<R>;
        empty: AssertFn<R>;
        error: ErrorLikeFn<R>;
        extensible: AssertFn<R>;
        false: AssertFn<R>;
        finite: AssertFn<R>;
        frozen: AssertFn<R>;
        function: AssertFn<R>;
        instanceof: InstanceOfFn<R>;
        instanceOf: InstanceOfFn<R>;
        iterable: AssertFn<R>;
        nan: AssertFn<R>;
        null: AssertFn<R>;
        number: AssertFn<R>;
        object: AssertFn<R>;
        ok: AssertFn<R>;
        plainObject: AssertFn<R>;
        sealed: AssertFn<R>;
        strictly: IStrictlyOp<R>;
        string: AssertFn<R>;
        true: AssertFn<R>;
        truthy: AssertFn<R>;
        typeOf(type: string, evalMsg?: MsgSource): R;
        undefined: AssertFn<R>;
    }

    Type Parameters

    • R

    Hierarchy (View Summary)

    Index

    Properties

    array boolean empty error extensible false finite frozen function instanceof instanceOf iterable nan null number object ok plainObject sealed strictly string true truthy undefined

    Methods

    typeOf

    Properties

    array: AssertFn<R>

    Asserts that the value is an array.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    boolean: AssertFn<R>

    Asserts that the value is a boolean.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    empty: AssertFn<R>

    Asserts that the value is empty.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    error: ErrorLikeFn<R>

    Asserts that the value is an error or matches the provided error constructor.

    The error or error constructor to match.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    extensible: AssertFn<R>

    Asserts that the value is extensible.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    false: AssertFn<R>

    Asserts that the value is false.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    finite: AssertFn<R>

    Asserts that the value is a finite number (not NaN, not Infinity, not -Infinity).

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    0.1.5

    frozen: AssertFn<R>

    Asserts that the value is frozen.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    function: AssertFn<R>

    Asserts that the value is a function.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    instanceof: InstanceOfFn<R>

    Asserts that the value is an instance of the specified constructor.

    The constructor to check against (e.g., Array, Date, Error, custom class).

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    0.1.5

    instanceOf: InstanceOfFn<R>

    Asserts that the value is an instance of the specified constructor.

    The constructor to check against (e.g., Array, Date, Error, custom class).

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    0.1.5

    iterable: AssertFn<R>

    Asserts that the value is iterable.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    nan: AssertFn<R>

    Asserts that the value is NaN.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    0.1.5

    null: AssertFn<R>

    Asserts that the value is null.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    number: AssertFn<R>

    Asserts that the value is a number.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    object: AssertFn<R>

    Asserts that the value is an object.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    ok: AssertFn<R>

    Asserts that the value is truthy.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    plainObject: AssertFn<R>

    Asserts that the value is a plain object.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    sealed: AssertFn<R>

    Asserts that the value is sealed.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    strictly: IStrictlyOp<R>

    Provides access to operations to confirm that the value strictly matches the type based on the used assertion operator.

    The custom message to display on evaluation.

    An object that provides operations to assert the value is strictly of the specified operation.

    string: AssertFn<R>

    Asserts that the value is a string.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    true: AssertFn<R>

    Asserts that the value is true.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    truthy: AssertFn<R>

    Asserts that the value is truthy.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    undefined: AssertFn<R>

    Asserts that the value is undefined.

    The custom message to display on evaluation.

    The current IAssertScope.that object.

    An AssertionFailure if the assertion fails.

    Methods

    • Asserts that the value's type matches the expected type string. Uses the JavaScript typeof operator for type comparison.

      Valid type strings include:

      • "string"
      • "number"
      • "bigint"
      • "boolean"
      • "symbol"
      • "undefined"
      • "object" (includes null, arrays, and objects)
      • "null"
      • "array"
      • "function" (includes async, generator, and async generator functions)
      • "asyncfunction"
      • "generatorfunction"
      • "asyncgeneratorfunction"

      Parameters

      • type: string

        The expected type string (e.g., "string", "number", "function")

      • OptionalevalMsg: MsgSource

        The custom message to display on evaluation.

      Returns R

      The current IAssertScope.that object.

      An AssertionFailure if the assertion fails.

      0.1.5

      expect("hello").is.typeof("string");
      expect(123).to.be.typeof("number");
      expect({}).is.typeof("object");
      expect(() => {}).to.be.typeof("function");

    Settings

    Member Visibility

    On This Page

    Properties
    Methods