Interface QueryRequestMessage

If you send a message it must not contain a newline but the message must be terminated by a newline.

interface QueryRequestMessage {
    filetoken: string;
    id: string | undefined;
    query: Queries<
        | "search"
        | "origin"
        | "call-context"
        | "config"
        | "dataflow"
        | "does-call"
        | "call-graph"
        | "control-flow"
        | "dataflow-lens"
        | "files"
        | "df-shape"
        | "normalized-ast"
        | "id-map"
        | "dataflow-cluster"
        | "static-slice"
        | "dependencies"
        | "location-map"
        | "happens-before"
        | "inspect-exception"
        | "inspect-higher-order"
        | "inspect-recursion"
        | "resolve-value"
        | "project"
        | "linter"
        | "provenance"
        | "input-sources",
    >;
    type: "request-query";
}

Hierarchy (View Summary)

IdMessageBase
- QueryRequestMessage

Hierarchy-Diagram

UML class diagram of QueryRequestMessage

Index

Properties

filetoken id query type

Properties

filetoken

filetoken: string

The FileAnalysisRequestMessage#filetoken of the file/data

id

id: string | undefined

The id that links a request with its responses, it is up to the calling client to make sure it is unique. However, the client does not have to pass the id if it does not need to link the request with its response. The id is always undefined if the message is unprompted (e.g., with hello) or the id unknown.

query

query: Queries<
    | "search"
    | "origin"
    | "call-context"
    | "config"
    | "dataflow"
    | "does-call"
    | "call-graph"
    | "control-flow"
    | "dataflow-lens"
    | "files"
    | "df-shape"
    | "normalized-ast"
    | "id-map"
    | "dataflow-cluster"
    | "static-slice"
    | "dependencies"
    | "location-map"
    | "happens-before"
    | "inspect-exception"
    | "inspect-higher-order"
    | "inspect-recursion"
    | "resolve-value"
    | "project"
    | "linter"
    | "provenance"
    | "input-sources",
>

The query to run on the file analysis information

type

type: "request-query"

The at this time unknown type