Class TypeInfoHelper

A descriptor is simply a JSON tree that either has an actual value or a type that identifies what the expect type should be at that leaf in the tree.

var descriptor = { a : Object, b : String, c : { d : true , e : Array, f : [] }, g : "literal" }

Hierarchy

Constructors

constructor

Properties

isArray isArrayLike isBoolean isFinite isFunction isNull isNullOrUndefined isNumber isObject isPrimitive isString isSymbol isTrueNaN isUndefined isValidNumber target type

Methods

as contains is member for

Constructors

constructor

Properties

Readonly isArray

isArray: boolean = false

Readonly isArrayLike

isArrayLike: boolean = false

Readonly isBoolean

isBoolean: boolean = false

Readonly isFinite

isFinite: boolean = false

Readonly isFunction

isFunction: boolean = false

Readonly isNull

isNull: boolean = false

Readonly isNullOrUndefined

isNullOrUndefined: boolean = false

Readonly isNumber

isNumber: boolean = false

Readonly isObject

isObject: boolean = false

Readonly isPrimitive

isPrimitive: boolean = false

Readonly isString

isString: boolean = false

Readonly isSymbol

isSymbol: boolean = false

Readonly isTrueNaN

isTrueNaN: boolean = false

Readonly isUndefined

isUndefined: boolean = false

Readonly isValidNumber

isValidNumber: boolean = false

Protected Readonly target

target: any

Readonly type

type: string

Methods

as

  • Returns null if the target does not match the type (instanceof). Otherwise returns the target as the type.

    Returns

    Type Parameters

    • T extends object

    Parameters

    • type: (new (...params: any[]) => T)
        • new (...params: any[]): T

        • Parameters

          • Rest ...params: any[]

          Returns T

    Returns null | T

contains

  • Type Parameters

    • TDescriptor

    Parameters

    • descriptor: unknown

    Returns this is TDescriptor

is

  • Returns true if the target matches the type (instanceof).

    Returns

    Type Parameters

    • T extends object

    Parameters

    • type: (new (...params: any[]) => T)
        • new (...params: any[]): T

        • Parameters

          • Rest ...params: any[]

          Returns T

    Returns boolean

member

  • Returns a TypeInfo for any member or non-member, where non-members are of type undefined.

    Returns

    Parameters

    • name: string | number | symbol

    Returns TypeInfo

Static for

  • Returns a TypeInfo for any target object. If the target object is of a primitive type, it returns the TypeInfo instance assigned to that type.

    Returns

    Parameters

    • target: unknown

    Returns TypeInfo

Settings

Member Visibility

Theme

Generated using TypeDoc