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

@creditkarma/graphql-loader

v0.7.1

Published

Build a GraphQL Schema by loading .graphql files based a glob pattern

Downloads

1,577

Readme

graphql-loader

Instantiate a GraphQL Schema by loading GraphQL Schema Language files based on a glob pattern

  • Allows creation of GraphQL Schema via GraphQL schema language shorthand
  • Supports splitting the schema into modules
  • Parse and validate schema files
  • Load GraphQL files from different modules and merge them into a single GraphQL Schema

Installation

npm install --save graphql @creditkarma/graphql-loader

Usage

Given the following files

schema/schema.graphql

schema {
  query: RootQuery
}

schema/rootQuery.graphql

type RootQuery {
  testString: String
}

loadSchema

Given a GLOB pattern, it will load all the content of the files matching the GLOB, combine them together and return a GraphQL Schema

Create a schema using promises:

const loader = require('@creditkarma/graphql-loader')

loader.loadSchema('./schema/*.graphql').then((schema) => {
  console.log(schema.getQueryType().toString())
})

Create a schema with a callback:

const loader = require('@creditkarma/graphql-loader')

loader.loadSchema('./schema/*.graphql', (err, schema) => {
  console.log(schema.getQueryType().toString())
})

Create a schema using sync:

const loader = require('@creditkarma/graphql-loader')

const schema = loader.loadSchema.sync('./schema/*.graphql')
console.log(schema.getQueryType().toString())

executableSchemaFromModules

Given an array of GraphQL Modules or functions that returns a GraphQL Module or Promise, merge the documents and resolvers together and return an executable GraphQL Schema

GraphQL modules are comprised of a document node and resolvers to provide away to decompose a GraphQL server into stand alone Node.js modules. These modules expose a DocumentNode because document nodes are valid GraphQL segments that are not required to be a complete valid schema.

It is required that the combination of GraphQLModules results in a completely valid GraphQLSchema.

const modules = [
  () => loadDocument('./fixtures/user/**/*.graphql').then((document) => ({ document, resolvers: {}})),
  () => loadDocument('./fixtures/swapi/**/*.graphql').then((document) => ({ document, resolvers: {}})),
]
executableSchemaFromModules(modules).then((schema) => {
  console.log(schema.getQueryType().toString())
})

loadDocument

Given a GLOB pattern, load the matching files, combine them together and return a GraphQL AST in the form of a DocumentNode. The document node will be parsed and validate but doesn't have to meet all the requirements of a full schema definition. For example, it is possible to just load several files with only types defined. NOTE: You must use a DocumentNode with the combineDocuments function

Load several GraphQL files into a single DocumentNode

const loader = require('@creditkarma/graphql-loader')

loader.loadDocument('./schema/*.graphql').then((doc) => {
  console.log(doc)
})

combineDocuments

Given an array of DocumentNodes, merge them together and return a GraphQLSchema

  • Any duplicate Type definitions will be merged by concatenating their fields
  • Any duplicate Schema definitions will be merged by concatenating their operations

Combine several documents into a GraphqlSchema

const loader = require('@creditkarma/graphql-loader')

Promise.all(
  loader.loadDocument('./ships/graphql/**/*.graphql'),
  loader.loadDocument('./planets/graphql/**/*.graphql')
).then((docs) => {
  const schema = combineDocuments(docs)
  console.log(schema.getQueryType().toString())
})

Development

Install dependencies with

npm install

Build

npm run build

Run test in watch mode

npm run test:watch

Contributing

For more information about contributing new features and bug fixes, see our Contribution Guidelines. External contributors must sign Contributor License Agreement (CLA)

License

This project is licensed under Apache License Version 2.0