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

schema-mapper-api

v0.4.2

Published

A module to retrieve, modify and save schemas.

Downloads

22

Readme

schema-mapper-api

A module to retrieve, modify and save schemas via node or over HTTP.

Build status Docs status Code Climate Dependencies License

Installation

npm install --save schema-mapper-api

Usage

var Api = require('schema-mapper-api');

// Setup connection to the schema-mapper-store
var store = new Api('http://localhost:9000');

// Retrieve a ProjectCollection
store.getProjectCollection()
  .then(function (projectCollection) {
    var project = {
      name: 'demo', // Project name (similar to a database name)
      version: 1, // Project version (versions is where schema-mapper shines)
      schemas: {
        // The keys in this oject are the unique id's for the schema
        '0': {
          name: 'users', // Schema name (similar to a database table)
          primary: '0', // The schema id of the primary key
          columns: {
            // The keys in this object are the unique id's for the columns
            '0': {
              name: 'id', // Column name (similar to database column name)
              type: 'integer' // Column type (see spec which types are supported)
            },
            '1': {
              name: 'email',
              type: 'string'
            }
          }
        }
      }
    };
    projectCollection.putProject('0', project);
    // Save the ProjectCollection
    // the ProjectCollection will be diffed with it's original version, only the changes will be sent to the store (via the Api), returns promise
    return projectCollection.save();
  })
  .then(function () {
    // The changes from the putProject command above are a project.create change and a project.tag change,
    // after these changes have been applied the storage engines are ready to accept data
    var item = {
      id: 1,
      email: '[email protected]'
    };
    return store.putItem(projectId, schemaId, item);
  });

API docs

For more methods on the store, see the docs at Api Docs

For more methods on the project collection, see the docs at ProjectCollection Docs

Licence

MIT