Interface ReferencesProvider

Language-specific service for handling find references requests.

interface ReferencesProvider {
    findReferences(document: LangiumDocument<AstNode>, params: ReferenceParams, cancelToken?: CancellationToken): MaybePromise<Location[]>;
}

Implemented by

Methods

  • Handle a find references request.

    Parameters

    • document: LangiumDocument<AstNode>

      The document in which to search for references.

    • params: ReferenceParams

      The parameters of the find references request.

    • OptionalcancelToken: CancellationToken

      A cancellation token that can be used to cancel the request.

    Returns MaybePromise<Location[]>

    The locations of the references.

    OperationCancelled if cancellation is detected during execution

    ResponseError if an error is detected that should be sent as response to the client