TypeScript SDK for sourcegraph.com API

GraphQL client for the
sourcegraph.com API

Sourcegraph is a web-based code search and navigation tool for dev teams. Search, navigate, and review code.

This SDK was created from the sourcegraph.com GraphQL API with Genql.

This library is fully type safe and thanks to TypeScript auto completion you can discover fields and methods very easily.

How to install

Use a package manager to install the API client

bash
npm install @genql/sourcegraph

Using the client

Use a package manager to install the API client

typescript
import { createClient } from '@genql/sourcegraph'
const client = createClient()

Passing headers

You can use the headers options to pass credentials or other headers

typescript
import { createClient } from '@genql/sourcegraph'
const client = createClient({
    headers: {
        Authorization: `Bearer ${Token}`
    }
})

Example queries

This SDK is generated from the sourcegraph.com GraphQL API so the client has a structure similar to the one used by GraphQL queries.

To fetch fields you need to explicitly pass field: true, you can also pass __args to fetch all scalar fields on a type.

Notice that to pass arguments you can use __args

typescript
import { createClient } from '@genql/sourcegraph'
const client = createClient()


// query variables
let after = ''
let before = ''

client
  .query({
    accessRequests: {
      __args: {
        after: after,
        before: before,
      },
      nodes: {
        additionalInfo: true,
        createdAt: true,
        email: true,
      },
      pageInfo: {
        endCursor: true,
        hasNextPage: true,
        hasPreviousPage: true,
      },
      totalCount: true,
    },
  })
  .then((x) => console.log(JSON.stringify(x, null, 4)))



client
  .query({ areExecutorsConfigured: true })
  .then((x) => console.log(JSON.stringify(x, null, 4)))

More usage examples

This SDK was created using Genql so you can find more usage examples in the main Genql website and docs

Other API clients

tezos.domains SDK pokeapi.co SDK See all SDK available