Function isBigObject

  • Determines if the value is a BigObject. A BigObject is an object with a value property of type bigint and a scale property of type number. It usually represents a Big instance.

    Parameters

    • value: unknown

      The value to check. Can be a Big instance or a BigObject.

    Returns value is BigObject

    • True if the value is a BigObject, false otherwise.

    Example

    isBigObject({ value: 123456n, scale: 2 }); // true
    isBigObject({ value: 123456n, scale: 2, foo: "bar" }); // true
    isBigObject({ value: 123456n }); // false
    isBigObject({ scale: 2 }); // false
    isBigObject({}); // false
    isBigObject(123456n); // false
    isBigObject({ value: "abc", scale: "2"}); // false

Generated using TypeDoc