Interface IsType

Extended interface that includes the base validation methods plus derivative methods. Provides not, all, and any modifiers for complex validation scenarios.

interface IsType {
    all: {
        defined(val: unknown, ...args: unknown[]): val is Object;
        exist(val?: unknown, ...args: unknown[]): val is Object;
        false(val: unknown, ...args: unknown[]): boolean;
        falsy(val: unknown, ...args: unknown[]): boolean;
        function(val: unknown, ...args: unknown[]): val is Function;
        null(val: unknown, ...args: unknown[]): val is null;
        stringContaining(thisStr: string, queryStr: string): boolean;
        true(val: unknown, ...args: unknown[]): boolean;
        truly(val: unknown, ...args: unknown[]): boolean;
        undefined(val: unknown, ...args: unknown[]): val is undefined;
    };
    any: {
        defined(val: unknown, ...args: unknown[]): val is Object;
        exist(val?: unknown, ...args: unknown[]): val is Object;
        false(val: unknown, ...args: unknown[]): boolean;
        falsy(val: unknown, ...args: unknown[]): boolean;
        function(val: unknown, ...args: unknown[]): val is Function;
        null(val: unknown, ...args: unknown[]): val is null;
        stringContaining(thisStr: string, queryStr: string): boolean;
        true(val: unknown, ...args: unknown[]): boolean;
        truly(val: unknown, ...args: unknown[]): boolean;
        undefined(val: unknown, ...args: unknown[]): val is undefined;
    };
    not: {
        defined(val: unknown, ...args: unknown[]): val is undefined;
        exist(val?: unknown, ...args: unknown[]): val is undefined | null;
        false(val: unknown, ...args: unknown[]): boolean;
        falsy(val: unknown, ...args: unknown[]): boolean;
        function(val: unknown, ...args: unknown[]): val is unknown;
        null(val: unknown, ...args: unknown[]): val is Object;
        true(val: unknown, ...args: unknown[]): boolean;
        truly(val: unknown, ...args: unknown[]): boolean;
        undefined(val: unknown, ...args: unknown[]): val is Object;
    };
    defined(val: unknown, ...args: unknown[]): val is Object;
    exist(val?: unknown, ...args: unknown[]): val is Object;
    false(val: unknown, ...args: unknown[]): boolean;
    falsy(val: unknown, ...args: unknown[]): boolean;
    function(val: unknown, ...args: unknown[]): val is Function;
    null(val: unknown, ...args: unknown[]): val is null;
    stringContaining(thisStr: string, queryStr: string): boolean;
    true(val: unknown, ...args: unknown[]): boolean;
    truly(val: unknown, ...args: unknown[]): boolean;
    undefined(val: unknown, ...args: unknown[]): val is undefined;
}

Hierarchy

IsImplType
- IsType

Index

Properties

all any not

Methods

defined exist false falsy function null stringContaining true truly undefined

Properties

all

all: {
    defined(val: unknown, ...args: unknown[]): val is Object;
    exist(val?: unknown, ...args: unknown[]): val is Object;
    false(val: unknown, ...args: unknown[]): boolean;
    falsy(val: unknown, ...args: unknown[]): boolean;
    function(val: unknown, ...args: unknown[]): val is Function;
    null(val: unknown, ...args: unknown[]): val is null;
    stringContaining(thisStr: string, queryStr: string): boolean;
    true(val: unknown, ...args: unknown[]): boolean;
    truly(val: unknown, ...args: unknown[]): boolean;
    undefined(val: unknown, ...args: unknown[]): val is undefined;
}

Type declaration

defined:function
- defined(val, ...args): val is Object
- Checks if a value is defined (not undefined).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is Object
  True if the value is not undefined
  - Defined in foundation/misc/Is.ts:20
exist:function
- exist(val?, ...args): val is Object
- Checks if a value exists (is neither null nor undefined).
  Parameters
  - Optionalval: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is Object
  True if the value is not null and not undefined
  - Defined in foundation/misc/Is.ts:50
false:function
- false(val, ...args): boolean
- Checks if a value is strictly equal to false.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is exactly false
  - Defined in foundation/misc/Is.ts:90
falsy:function
- falsy(val, ...args): boolean
- Checks if a value is falsy (converts to false in boolean context).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is falsy
  - Defined in foundation/misc/Is.ts:100
function:function
- function(val, ...args): val is Function
- Checks if a value is a function.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is Function
  True if the value is a function
  - Defined in foundation/misc/Is.ts:60
null:function
- null(val, ...args): val is null
- Checks if a value is null.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is null
  True if the value is null
  - Defined in foundation/misc/Is.ts:40
stringContaining:function
- stringContaining(thisStr, queryStr): boolean
- Checks if a string contains another string.
  Parameters
  - thisStr: string
    The string to search in
  - queryStr: string
    The string to search for
  Returns boolean
  True if thisStr contains queryStr
  - Defined in foundation/misc/Is.ts:110
true:function
- true(val, ...args): boolean
- Checks if a value is strictly equal to true.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is exactly true
  - Defined in foundation/misc/Is.ts:70
truly:function
- truly(val, ...args): boolean
- Checks if a value is truthy (converts to true in boolean context).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is truthy
  - Defined in foundation/misc/Is.ts:80
undefined:function
- undefined(val, ...args): val is undefined
- Checks if a value is undefined.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is undefined
  True if the value is undefined
  - Defined in foundation/misc/Is.ts:30

any

any: {
    defined(val: unknown, ...args: unknown[]): val is Object;
    exist(val?: unknown, ...args: unknown[]): val is Object;
    false(val: unknown, ...args: unknown[]): boolean;
    falsy(val: unknown, ...args: unknown[]): boolean;
    function(val: unknown, ...args: unknown[]): val is Function;
    null(val: unknown, ...args: unknown[]): val is null;
    stringContaining(thisStr: string, queryStr: string): boolean;
    true(val: unknown, ...args: unknown[]): boolean;
    truly(val: unknown, ...args: unknown[]): boolean;
    undefined(val: unknown, ...args: unknown[]): val is undefined;
}

Type declaration

defined:function
- defined(val, ...args): val is Object
- Checks if a value is defined (not undefined).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is Object
  True if the value is not undefined
  - Defined in foundation/misc/Is.ts:20
exist:function
- exist(val?, ...args): val is Object
- Checks if a value exists (is neither null nor undefined).
  Parameters
  - Optionalval: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is Object
  True if the value is not null and not undefined
  - Defined in foundation/misc/Is.ts:50
false:function
- false(val, ...args): boolean
- Checks if a value is strictly equal to false.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is exactly false
  - Defined in foundation/misc/Is.ts:90
falsy:function
- falsy(val, ...args): boolean
- Checks if a value is falsy (converts to false in boolean context).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is falsy
  - Defined in foundation/misc/Is.ts:100
function:function
- function(val, ...args): val is Function
- Checks if a value is a function.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is Function
  True if the value is a function
  - Defined in foundation/misc/Is.ts:60
null:function
- null(val, ...args): val is null
- Checks if a value is null.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is null
  True if the value is null
  - Defined in foundation/misc/Is.ts:40
stringContaining:function
- stringContaining(thisStr, queryStr): boolean
- Checks if a string contains another string.
  Parameters
  - thisStr: string
    The string to search in
  - queryStr: string
    The string to search for
  Returns boolean
  True if thisStr contains queryStr
  - Defined in foundation/misc/Is.ts:110
true:function
- true(val, ...args): boolean
- Checks if a value is strictly equal to true.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is exactly true
  - Defined in foundation/misc/Is.ts:70
truly:function
- truly(val, ...args): boolean
- Checks if a value is truthy (converts to true in boolean context).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is truthy
  - Defined in foundation/misc/Is.ts:80
undefined:function
- undefined(val, ...args): val is undefined
- Checks if a value is undefined.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is undefined
  True if the value is undefined
  - Defined in foundation/misc/Is.ts:30

not

not: {
    defined(val: unknown, ...args: unknown[]): val is undefined;
    exist(val?: unknown, ...args: unknown[]): val is undefined | null;
    false(val: unknown, ...args: unknown[]): boolean;
    falsy(val: unknown, ...args: unknown[]): boolean;
    function(val: unknown, ...args: unknown[]): val is unknown;
    null(val: unknown, ...args: unknown[]): val is Object;
    true(val: unknown, ...args: unknown[]): boolean;
    truly(val: unknown, ...args: unknown[]): boolean;
    undefined(val: unknown, ...args: unknown[]): val is Object;
}

Type declaration

defined:function
- defined(val, ...args): val is undefined
- Checks if a value is undefined (negated version of defined).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is undefined
  True if the value is undefined
  - Defined in foundation/misc/Is.ts:171
exist:function
- exist(val?, ...args): val is undefined | null
- Checks if a value does not exist (is null or undefined).
  Parameters
  - Optionalval: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is undefined | null
  True if the value is null or undefined
  - Defined in foundation/misc/Is.ts:201
false:function
- false(val, ...args): boolean
- Checks if a value is not strictly equal to false.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is not exactly false
  - Defined in foundation/misc/Is.ts:241
falsy:function
- falsy(val, ...args): boolean
- Checks if a value is not falsy (negated version of falsy).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is not falsy
  - Defined in foundation/misc/Is.ts:251
function:function
- function(val, ...args): val is unknown
- Checks if a value is not a function.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is unknown
  True if the value is not a function
  - Defined in foundation/misc/Is.ts:211
null:function
- null(val, ...args): val is Object
- Checks if a value is not null.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is Object
  True if the value is not null
  - Defined in foundation/misc/Is.ts:191
true:function
- true(val, ...args): boolean
- Checks if a value is not strictly equal to true.
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is not exactly true
  - Defined in foundation/misc/Is.ts:221
truly:function
- truly(val, ...args): boolean
- Checks if a value is not truthy (negated version of truly).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns boolean
  True if the value is not truthy
  - Defined in foundation/misc/Is.ts:231
undefined:function
- undefined(val, ...args): val is Object
- Checks if a value is defined (negated version of undefined).
  Parameters
  - val: unknown
    The value to check
  - Rest...args: unknown[]
    Additional arguments (unused)
  Returns val is Object
  True if the value is not undefined
  - Defined in foundation/misc/Is.ts:181

Methods

defined

defined(val, ...args): val is Object
Checks if a value is defined (not undefined).
Parameters
- val: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns val is Object
True if the value is not undefined
Inherited from IsImplType.defined
- Defined in foundation/misc/Is.ts:20

exist

exist(val?, ...args): val is Object
Checks if a value exists (is neither null nor undefined).
Parameters
- Optionalval: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns val is Object
True if the value is not null and not undefined
Inherited from IsImplType.exist
- Defined in foundation/misc/Is.ts:50

false

false(val, ...args): boolean
Checks if a value is strictly equal to false.
Parameters
- val: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns boolean
True if the value is exactly false
Inherited from IsImplType.false
- Defined in foundation/misc/Is.ts:90

falsy

falsy(val, ...args): boolean
Checks if a value is falsy (converts to false in boolean context).
Parameters
- val: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns boolean
True if the value is falsy
Inherited from IsImplType.falsy
- Defined in foundation/misc/Is.ts:100

function

function(val, ...args): val is Function
Checks if a value is a function.
Parameters
- val: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns val is Function
True if the value is a function
Inherited from IsImplType.function
- Defined in foundation/misc/Is.ts:60

null

null(val, ...args): val is null
Checks if a value is null.
Parameters
- val: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns val is null
True if the value is null
Inherited from IsImplType.null
- Defined in foundation/misc/Is.ts:40

stringContaining

stringContaining(thisStr, queryStr): boolean
Checks if a string contains another string.
Parameters
- thisStr: string
  The string to search in
- queryStr: string
  The string to search for
Returns boolean
True if thisStr contains queryStr
Inherited from IsImplType.stringContaining
- Defined in foundation/misc/Is.ts:110

true

true(val, ...args): boolean
Checks if a value is strictly equal to true.
Parameters
- val: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns boolean
True if the value is exactly true
Inherited from IsImplType.true
- Defined in foundation/misc/Is.ts:70

truly

truly(val, ...args): boolean
Checks if a value is truthy (converts to true in boolean context).
Parameters
- val: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns boolean
True if the value is truthy
Inherited from IsImplType.truly
- Defined in foundation/misc/Is.ts:80

undefined

undefined(val, ...args): val is undefined
Checks if a value is undefined.
Parameters
- val: unknown
  The value to check
- Rest...args: unknown[]
  Additional arguments (unused)
Returns val is undefined
True if the value is undefined
Inherited from IsImplType.undefined
- Defined in foundation/misc/Is.ts:30

Interface IsType

Hierarchy

Index

Properties

Methods

Properties

all

Type declaration

defined:function

Parameters

Returns val is Object

exist:function

Parameters

Returns val is Object

false:function

Parameters

Returns boolean

falsy:function

Parameters

Returns boolean

function:function

Parameters

Returns val is Function

null:function

Parameters

Returns val is null

stringContaining:function

Parameters

Returns boolean

true:function

Parameters

Returns boolean

truly:function

Parameters

Returns boolean

undefined:function

Parameters

Returns val is undefined

any

Type declaration

defined:function

Parameters

Returns val is Object

exist:function

Parameters

Returns val is Object

false:function

Parameters

Returns boolean

falsy:function

Parameters

Returns boolean

function:function

Parameters

Returns val is Function

null:function

Parameters

Returns val is null

stringContaining:function

Parameters

Returns boolean

true:function

Parameters

Returns boolean

truly:function

Parameters

Returns boolean

undefined:function

Parameters

Returns val is undefined

not

Type declaration

defined:function

Parameters

Returns val is undefined

exist:function

Parameters

Returns val is undefined | null

false:function

Parameters