Class SourceGraphClient

constructor

• new SourceGraphClient(options: SourceGraphClientOptions): SourceGraphClient

  Parameters

  • options: SourceGraphClientOptions

  Returns SourceGraphClient

Readonlyheaders

Readonlyoptions

raw

• raw(query: string, options?: SearchOptions): AsyncGenerator<SSEMessage>

  Returns the raw SSE messages from Sourcegraph search API

  The Sourcegraph messages are stringified JSON objects, this method parses the objects so that the data field of each message is an object (or array) instead of a string. In case of parsing error, the original string is kept.

  Parameters

  • query: string
  • options: SearchOptions = {}

  Returns AsyncGenerator<SSEMessage>

search

• search(query: string, options?: SearchOptions): AsyncGenerator<SearchResult>

  Search Sourcegraph with the given query. Returns an async generator yielding search results as they are received.

  Parameters

  • query: string
  • options: SearchOptions = {}

  Returns AsyncGenerator<SearchResult>

  Example

  const client = new SourceGraphClient({
       url: "https://example.sourcegraph.com/.api/search/stream",
       accessToken: "your-token
   });
  
   for await (const result of client.search("search-term")) {
       console.log(result);
   }
  
  Copy