@servicenow/sdk - v4.4.1
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get compilerType(): TType

      Gets the underlying compiler type.

      Returns TType

    Methods

    • Gets the alias symbol if it exists.

      Returns Symbol | undefined

    • Gets the alias symbol if it exists, or throws.

      Parameters

      • Optionalmessage: string | (() => string)

      Returns Symbol

    • Gets the apparent properties of the type.

      Returns Symbol[]

    • Gets an apparent property.

      Parameters

      • name: string

        By a name.

      Returns Symbol | undefined

    • Gets an apparent property.

      Parameters

      • findFunction: (declaration: Symbol) => boolean

        Function for searching for an apparent property.

      Returns Symbol | undefined

    • Gets the apparent type.

      Returns Type

    • Gets the array element type or returns undefined if it doesn't exist (ex. for T[] it would be T).

      Returns Type<tsc.Type> | undefined

    • Gets the array element type or throws if it doesn't exist (ex. for T[] it would be T).

      Parameters

      • Optionalmessage: string | (() => string)

      Returns Type<tsc.Type>

    • Gets the base type of a literal type.

      For example, for a number literal type it will return the number type.

      Returns Type<tsc.Type>

    • Gets the call signatures.

      Returns Signature[]

    • Gets the constraint type.

      Returns Type<tsc.Type> | undefined

    • Gets the constraint or throws if it doesn't exist.

      Parameters

      • Optionalmessage: string | (() => string)

      Returns Type

    • Gets the default type or undefined if it doesn't exist.

      Returns Type<tsc.Type> | undefined

    • Gets the default type or throws if it doesn't exist.

      Parameters

      • Optionalmessage: string | (() => string)

      Returns Type

    • Gets the type flags.

      Returns tsc.TypeFlags

    • Gets the intersection types (ex. for T & U it returns the array [T, U]).

      Returns Type<tsc.Type>[]

    • Gets the fresh type of the literal or returns undefined if this is not a literal type.

      Note: I have no idea what this means. Please help contribute to these js docs if you know.

      Returns Type<FreshableType> | undefined

    • Gets the fresh type of the literal or throws if this is not a literal type.

      Note: I have no idea what this means. Please help contribute to these js docs if you know.

      Parameters

      • Optionalmessage: string | (() => string)

      Returns Type<FreshableType>

    • Gets the regular type of the literal or returns undefined if this is not a literal type.

      Note: I have no idea what this means. Please help contribute to these js docs if you know.

      Returns Type<FreshableType> | undefined

    • Gets the regular type of the literal or throws if this is not a literal type.

      Note: I have no idea what this means. Please help contribute to these js docs if you know.

      Parameters

      • Optionalmessage: string | (() => string)

      Returns Type<FreshableType>

    • Gets the value of a literal or returns undefined if this is not a literal type.

      Returns string | number | PseudoBigInt | undefined

    • Gets the value of the literal or throws if this is not a literal type.

      Parameters

      • Optionalmessage: string | (() => string)

      Returns string | number | PseudoBigInt

    • Gets the non-nullable type.

      Returns Type

    • Gets the number index type.

      Returns Type<tsc.Type> | undefined

    • Gets the properties of the type.

      Returns Symbol[]

    • Gets a property or returns undefined if it does not exist.

      Parameters

      • name: string

        By a name.

      Returns Symbol | undefined

    • Gets a property or returns undefined if it does not exist.

      Parameters

      • findFunction: (declaration: Symbol) => boolean

        Function for searching for a property.

      Returns Symbol | undefined

    • Gets a property or throws if it doesn't exist.

      Parameters

      • name: string

        By a name.

      Returns Symbol

    • Gets a property or throws if it doesn't exist.

      Parameters

      • findFunction: (declaration: Symbol) => boolean

        Function for searching for a property.

      Returns Symbol

    • Gets the string index type.

      Returns Type<tsc.Type> | undefined

    • Gets the symbol of the type.

      Returns Symbol | undefined

    • Gets the symbol of the type or throws.

      Parameters

      • Optionalmessage: string | (() => string)

      Returns Symbol

    • Returns the generic type when the type is a type reference, returns itself when it's already a generic type, or otherwise returns undefined.

      For example:

      • Given type reference Promise<string> returns Promise<T>.
      • Given generic type Promise<T> returns the same Promise<T>.
      • Given string returns undefined.

      Returns Type<GenericType> | undefined

    • Returns the generic type when the type is a type reference, returns itself when it's already a generic type, or otherwise throws an error.

      For example:

      • Given type reference Promise<string> returns Promise<T>.
      • Given generic type Promise<T> returns the same Promise<T>.
      • Given string throws an error.

      Parameters

      • Optionalmessage: string | (() => string)

      Returns Type<GenericType>

    • Gets the type text.

      Parameters

      Returns string

    • Gets the individual element types of the tuple.

      Returns Type<tsc.Type>[]

    • Gets the union types (ex. for T | U it returns the array [T, U]).

      Returns Type<tsc.Type>[]

    • Gets if this is an anonymous type.

      Returns boolean

    • Gets if this is an any type.

      Returns boolean

    • Gets if this is an array type.

      Returns boolean

    • Gets if the type is assignable to another type.

      Parameters

      Returns boolean

    • Gets if this is a BigInt.

      Returns boolean

    • Gets if this is a BigInt literal type.

      Returns boolean

    • Gets if this is a boolean type.

      Returns boolean

    • Gets if this is a boolean literal type.

      Returns boolean

    • Gets if this is an enum type.

      Returns boolean

    • Gets if this is an enum literal type.

      Returns boolean

    • Gets if this is a literal type.

      Returns boolean

    • Gets if this is a never type.

      Returns boolean

    • Gets if this is the null type.

      Returns boolean

    • Gets if the type is possibly null or undefined.

      Returns boolean

    • Gets if this is a number type.

      Returns boolean

    • Gets if this is an object type.

      Returns this is Type<ObjectType>

    • Gets if this is a readonly array type.

      Returns boolean

    • Gets if this is a string type.

      Returns boolean

    • Gets if this is a tuple type.

      Returns this is Type<TupleType>

    • Gets if this is a type parameter.

      Returns this is TypeParameter

    • Gets if this is the undefined type.

      Returns boolean

    • Gets if this is a union type.

      Returns this is Type<UnionType>

    • Gets if this is the unknown type.

      Returns boolean

    • Gets if this is the void type.

      Returns boolean