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

mongoose-graphql-type

v1.0.0

Published

Convert a mongoose model to a GraphQL type string

Downloads

2

Readme

mongoose-graphql CircleCI

mongoose-graphql converts a mongoose model to graphql types.

Installation

Using npm:

$ npm install --save mongoose-graphql
// using ES6 modules
import { modelToType } from 'mongoose-graphql';

// using CommonJS modules
var mongooseGraphQL = require('mongoose-graphql');
var modelToType = mongooseGraphQL.modelToType;

API

modelToType

modelToType(model, options)

Convert a mongoose model to graphql types.

You can use this type definition in graphql-tools to build an executable schema.

const CategorySchema = new Schema({
  type: String,
});

const BookModel = mongoose.model('Book', new Schema({
  category: CategorySchema,
  name: String,
}));

const typeDef = modelToType(BookModel, {
  extend: {
    Book: {
      publishers: '[Publisher]',
    },
    BookCategory: {
      genre: 'Genre',
    },
  },
});

console.log(typeDef);

Outputs:

type BookCategory {
  _id: String
  genre: Genre
  type: String
}
type Book {
  _id: String
  category: BookCategory
  name: String
  publishers: [Publisher]
}

Graphql private properties

Graphql does not allow properties beginning with "__" in types. Otherwise, it will print a message error like this :

Name "__t" must not begin with "__", which is reserved by GraphQL introspection. In a future release of graphql this will become a hard error.

By default, this kind of properties is removed by mongoose-graphql.