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

    Accessors

    • get compilerSymbol(): tsc.Symbol

      Gets the underlying compiler symbol.

      Returns tsc.Symbol

    Methods

    • Gets the aliased symbol or returns undefined if it doesn't exist.

      Returns Symbol | undefined

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

      Parameters

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

      Returns Symbol

    • Gets the symbol declarations.

      Returns Node<tsc.Node>[]

    • Gets the declared type of the symbol.

      Returns Type

    • Gets the escaped name.

      Returns string

    • Gets the export of the symbol by the specified name or returns undefined if not exists.

      Parameters

      • name: string

        Name of the export.

      Returns Symbol | undefined

    • Gets the export of the symbol by the specified name or throws if not exists.

      Parameters

      • name: string

        Name of the export.

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

      Returns Symbol

    • Gets the exports from the symbol.

      Returns Symbol[]

    • Gets the export symbol of the symbol if its a local symbol with a corresponding export symbol. Otherwise returns the current symbol.

      The following is from the compiler API documentation:

      For example, at export type T = number;: - getSymbolAtLocation at the location T will return the exported symbol for T. - But the result of getSymbolsInScope will contain the local symbol for T, not the exported symbol. - Calling getExportSymbol on that local symbol will return the exported symbol.

      Returns Symbol

    • Gets the symbol flags.

      Returns tsc.SymbolFlags

    • Gets the fully qualified name.

      Returns string

    • Gets the global export of the symbol by the specified name or returns undefined if not exists.

      Parameters

      • name: string

        Name of the global export.

      Returns Symbol | undefined

    • Gets the global export of the symbol by the specified name or throws if not exists.

      Parameters

      • name: string

        Name of the global export.

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

      Returns Symbol

    • Gets the global exports from the symbol.

      Returns Symbol[]

    • Follows a single alias to get the immediately aliased symbol or returns undefined if it doesn't exist.

      Returns Symbol | undefined

    • Follows a single alias to get the immediately aliased symbol or throws if it doesn't exist.

      Parameters

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

      Returns Symbol

    • Gets the JS doc tag infos of the symbol.

      Returns JSDocTagInfo[]

    • Gets the member of the symbol by the specified name or returns undefined if not exists.

      Parameters

      • name: string

        Name of the member.

      Returns Symbol | undefined

    • Gets the member of the symbol by the specified name or throws if not exists.

      Parameters

      • name: string

        Name of the export.

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

      Returns Symbol

    • Gets the members of the symbol

      Returns Symbol[]

    • Gets the symbol name.

      Returns string

    • Gets the type of the symbol at a location.

      Parameters

      • node: Node

        Location to get the type at for this symbol.

      Returns Type<tsc.Type>

    • Gets the value declaration of the symbol or returns undefined if it doesn't exist.

      Returns Node<tsc.Node> | undefined

    • Gets the value declaration of a symbol or throws if it doesn't exist.

      Parameters

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

      Returns Node

    • Gets if the symbol has the specified flags.

      Parameters

      Returns boolean

    • Gets if the symbol is an alias.

      Returns boolean

    • Gets if the symbol is optional.

      Returns boolean