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

    Interface ReferencesResponseItem

    Object found in response messages defining a span of text in a specific source file.

    interface ReferencesResponseItem {
        contextEnd?: tsc.server.protocol.Location;
        contextStart?: tsc.server.protocol.Location;
        end: tsc.server.protocol.Location;
        file: string;
        isDefinition?: boolean;
        isWriteAccess: boolean;
        lineText?: string;
        start: tsc.server.protocol.Location;
    }

    Hierarchy (View Summary)

    Index

    Properties

    contextEnd? contextStart? end file isDefinition? isWriteAccess lineText? start

    Properties

    contextEnd?: tsc.server.protocol.Location
    contextStart?: tsc.server.protocol.Location
    end: tsc.server.protocol.Location

    One character past last character of the definition.

    file: string

    File containing text span.

    isDefinition?: boolean

    Present only if the search was triggered from a declaration. True indicates that the references refers to the same symbol (i.e. has the same meaning) as the declaration that began the search.

    isWriteAccess: boolean

    True if reference is a write location, false otherwise.

    lineText?: string

    Text of line containing the reference. Including this with the response avoids latency of editor loading files to show text of reference line (the server already has loaded the referencing files).

    If UserPreferences.disableLineTextInReferences is enabled, the property won't be filled

    start: tsc.server.protocol.Location

    First character of the definition.

    Settings

    Member Visibility

    On This Page

    Properties