npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

update-graphql-schema

v0.3.0

Published

A module and cli tool for updating graphql schema

Downloads

249

Readme

update-graphql-schema

A module and cli tool for updating graphql schema from Graphql server

CircleCI branch Codecov Dependencies DevDependencies

npm package npm downloads

Usage

Install

Use npm:

npm i update-graphql-schema
npm i update-graphql-schema -g

Or use yarn:

yarn add update-graphql-schema
yarn global add update-graphql-schema

Cli

Usage: updateSchema [options] <file ...>

Options:
  -v, --version            output the version number
  -c, --config <file ...>  Config files path
  -h, --headers <items>    Request Headers
  -o, --output <file ...>  Output Path, Default: `${process.cwd()}/schema.json`
  -p, --point [value]      Endpoint url
  -t, --type [value]       Schema type `json` or `graphql`. Note: It will always be `json` if output file extension is `json`.
  -h, --help               output usage information

With Config File

Config file ./updateSchemaConf.js

module.exports = {
  point: 'https://your.graphql.server/graphq',
  output: './schema.json',
  type: 'json', // or graphq
  headers: {
    authorization: 'bear XXXXXXXXXXXXXXXXXX',
  },
};

Or use json conf ./updateSchemaConf.json

{
  "point": "https://your.graphql.server/graphq",
  "output": "./schema.graphql",
  "type": "graphql",
  "headers": {
    "authorization": "bear XXXXXXXXXXXXXXXXXX"
  }
}

Then, run this command

updateSchema -c ./updateSchemaConf.js
// or
// updateSchema -c ./updateSchemaConf.json

Node modules

const updateGraphqlSchema = require('update-graphql-schema');
const path = require('path');

updateGraphqlSchema({
  endPoint: 'https://api.github.com/graphql',
  output: path.resolve(__dirname, 'schema.graphql'),
  schemaType: 'graphql',
  headers: {
    Authorization: 'bearer 4ad4XXXXXXXXXXXXXXXXX85bf7',
  },
});

Contributing

DefinitelyTyped only works because of contributions by users like you!

Git Message

Follow the Angular git commit message specification

But, you can ignore the scope