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

graphqlize

v0.1.1

Published

Expose GraphQL services from Plain JavaScript Classes

Downloads

5

Readme

Graphqlize

Warning: Work In Progress

This library creates a GraphQL schema from plain JavaScript classes. With this code:

class Query {
  /**
   * List a few comments
   * @param {number} offset - The offset of...
   * @param {number} limit - The limit of...
   * @param {int} limit
   * @param {int} offset
   * @return {Comment[]} - The result of...
   */
  static list (limit, offset) {
    return [{
      text: 'hello world!'
    }]
  }
}

class Comment {
  constructor () {
    /** @type {string!} - The id of a comment */
    this.id = null
    /** @type {string} - The content of a comment */
    this.text = null
    /** @type {boolean} - Flag that indicates if the comment was deleted */
    this.deleted = null
  }

  /**
   * Gets whatever
   * @param {context} ctxt
   * @return {string} - The result of...
   */
  whatever (ctxt) {
    return Promise.resolve(this.text + ' heyyyyyy ' + ctxt.foo)
  }
}

Just using graphqlize

const { createSchema } = require('graphqlize')
const schema = createSchema(Query, Comment)

You get a GraphQL schema with this schema:

type Comment {
  # The id of a comment
  id: String!

  # The content of a comment
  text: String

  # Flag that indicates if the comment was deleted
  deleted: Boolean
  whatever: String
}

type Query {
  list(limit: Int, offset: Int): [Comment]
}

Once you have the schema you can run a server with it:

var app = express()
app.use('/graphql', graphqlHTTP({
  schema: schema,
  graphiql: true,
  context: {}
}))

Based on JSDocs

Each class represents a GraphQL type. You annotate the classes with standard JSDocs attributes. It supports the following types:

  • string: maps to GraphQLString
  • number or float: maps to GraphQLFloat
  • int: maps to GraphQLInt
  • boolean: maps to GraphQLBoolean
  • ID: GraphQLID
  • Custom types
  • Arrays of any previous type
  • not-nullability with {type!}
  • using @param {context} in a particular field you will get the GraphQL context injected for that argument

You just need to call createSchema passing all the types/classes that you want to expose

createSchema(Query, Class2, Class3,...)

The first class will be the root in the schema. Methods act like attributes with arguments. They can be static or not.