extract-schema-coordinates

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

extract-schema-coordinates

★ 12 Open GitHub ↗

Extract field coordinates from GraphQL documents

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# extract-schema-coordinates

Extract a list of "schema coordinates" contained in a GraphQL document

## Install

```bash
$ yarn add extract-schema-coordinates
```

## Example

e.g. for the following query:

```graphql
query GET_BUSINESS($BizId: String) {
    business(id: $BizId) {
        name
        location {
            city
        }
    }
}
```

We would return the following set of schema coordinates:

```json
["Query.business", "Business.name", "Business.location", "Location.city"]
```

## API

```
extractSchemaCoordinates(
    /**
     * The text of the document to analyse, in raw string format
     */
    documentText: string,
    /**
     * The text of your schema, in string SDL format (e.g. as created by printSchema)
     * @see https://graphql.org/graphql-js/utilities/#printschema
     */
    schemaText: string,
): Set<string>
```

### Usage:

```js
import extractSchemaCoordinates from 'extract-schema-coordinates';
const coordinates = extractSchemaCoordinates(documentString, schemaText);
```

extract-schema-coordinates

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README