Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

gql-types-generator

Package Overview
Dependencies
Maintainers
1
Versions
48
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gql-types-generator - npm Package Compare versions

Comparing version 1.2.11 to 1.2.12

5

package.json
{
"name": "gql-types-generator",
"version": "1.2.11",
"version": "1.2.12",
"main": "dist/index.js",

@@ -24,3 +24,4 @@ "types": "dist/index.d.ts",

"build": "rimraf dist && tsc -p tsconfig.json",
"dev": "tsc -w"
"dev": "tsc -w",
"release": "yarn build && yarn publish"
},

@@ -27,0 +28,0 @@ "dependencies": {

33

README.md

@@ -30,3 +30,3 @@ gql-types-generator

### Command line interface
## Command line interface
After installation of package is done, `gql-types-generator` command

@@ -46,9 +46,6 @@ becomes available.

> **Warning**
>
> When using CLI, each glob will be formatted as process.cwd() + glob. You can
> pass an array of globs using comma between them like
> `src/schema1.graphql,src/schema2.graphql`
When using CLI, each glob will be formatted as process.cwd() + glob. You can
pass an array of globs using comma between them like `src/schema1.graphql,src/schema2.graphql`
### Programmatic control
## Programmatic control
Library provides such functions as `compile`, `compileSchema` and

@@ -59,4 +56,4 @@ `compileOperations` to generate types.

#### `compile`
##### List of available options
### `compile`
#### List of available options

@@ -68,6 +65,6 @@ | Name | Type | Description |

| `display` | `DisplayType?` | How to display compiled types. Valid values are "as-is" and "default". By default, generator compiles scalars first, then enums, interfaces, inputs, unions and then types. "as-is" places types as they are placed in schema |
| `schemaPath` | `PathType` | Defines paths to schema. Watch [possible values](https://github.com/wolframdeus/gql-types-generator/blob/master/src/types/compiler.ts#L23-L26) for more |
| `operationsPath` | `PathType?` | Defines paths to operations. Watch [possible values](https://github.com/wolframdeus/gql-types-generator/blob/master/src/types/compiler.ts#L23-L26) for more |
| `schemaPath` | `PathType` | Defines paths to schema. Watch [possible values](https://github.com/wolframdeus/gql-types-generator/blob/master/src/types/compilation.ts#L23-L26) for more |
| `operationsPath` | `PathType?` | Defines paths to operations. Watch [possible values](https://github.com/wolframdeus/gql-types-generator/blob/master/src/types/compilation.ts#L23-L26) for more |
##### Example
#### Example
```typescript

@@ -109,4 +106,4 @@ import {compile} from 'gql-types-generator';

#### `compileSchema(schemaString, outputDirectory, includeDescription?, display?)`
##### List of available options
### `compileSchema(schemaString, outputDirectory, includeDescription?, display?)`
#### List of available options

@@ -120,3 +117,3 @@ | Name | Type | Description |

##### Example
#### Example
```typescript

@@ -136,4 +133,4 @@ import {compileSchema} from 'gql-types-generator';

#### `compileOperations(schemaString, outputDirectory, includeDescription?, display?)`
##### List of available options
### `compileOperations(schemaString, outputDirectory, includeDescription?, display?)`
#### List of available options

@@ -146,3 +143,3 @@ | Name | Type | Description |

##### Example
#### Example
```typescript

@@ -149,0 +146,0 @@ import {compileOperations} from 'gql-types-generator';

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc