source-graph-stream-client
    Preparing search index...

    Type Alias SearchOptions

    Options for configuring the search query.

    https://sourcegraph.com/docs/api/stream_api

    type SearchOptions = {
        contextLines?: number;
        displayLimit?: number;
        enableChunkMatches?: boolean;
        maxLineLength?: number;
        patternType?: "keyword" | "standard" | "regexp";
        version?: string;
    }
    Index

    Properties

    contextLines? displayLimit? enableChunkMatches? maxLineLength? patternType? version?

    Properties

    contextLines?: number

    The number of lines around a match that should be returned. Works only in conjunction with cm=true. Must be parseable as boolean.

    1
    displayLimit?: number

    The maximum number of matches the backend returns. If the backend finds more than display-limit results, it will keep searching and aggregating statistics, but the matches will not be returned anymore. Note that the display-limit is different from the query filter count: which causes the search to stop and return once we found count: matches.

    -1 (no limit)
    enableChunkMatches?: boolean

    Enables chunk matches. Must be parseable as boolean.

    false
    maxLineLength?: number

    If set, will truncate the context field of ChunkMatch such that no line is longer than max-line-len.

    -1 (no limit)
    patternType?: "keyword" | "standard" | "regexp"

    Either "keyword", "standard", or "regexp". This pattern type is only used if the query doesn't already contain a patternType: filter.

    "standard"
    version?: string

    The version of the search query syntax. We recommend to explicitly set the version. The latest version is "V3".

    "V3"

    Settings

    Member Visibility

    On This Page

    Properties