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

waterline-parse

v0.0.1

Published

parse adapter for Sails / Waterline

Downloads

2

Readme

Build Status

waterline-parse

Provides easy access to parse from Sails.js & Waterline.

This module is a Waterline/Sails adapter, an early implementation of a rapidly-developing, tool-agnostic data standard. Its goal is to provide a set of declarative interfaces, conventions, and best-practices for integrating with all sorts of data sources. Not just databases-- external APIs, proprietary web services, or even hardware.

Strict adherence to an adapter specification enables the (re)use of built-in generic test suites, standardized documentation, reasonable expectations around the API for your users, and overall, a more pleasant development experience for everyone.

Installation

To install this adapter, run:

$ npm install waterline-parse

Usage

This adapter exposes the following methods:

find()
  • Status
    • Planned
create()
  • Status
    • Planned
update()
  • Status
    • Planned
destroy()
  • Status
    • Planned

Interfaces

TODO: Specify the interfaces this adapter will support. e.g. This adapter implements the [semantic]() and [queryable]() interfaces. For more information, check out this repository's FAQ and the adapter interface reference in the Sails docs.

Development

Check out Connections in the Sails docs, or see the config/connections.js file in a new Sails project for information on setting up adapters.

Getting started

It's usually pretty easy to add your own adapters for integrating with proprietary systems or existing open APIs. For most things, it's as easy as require('some-module') and mapping the appropriate methods to match waterline semantics. To get started:

  1. Fork this repository
  2. Set up your README.md and package.json file. Sails.js adapter module names are of the form sails-*, where * is the name of the datastore or service you're integrating with.
  3. Build your adapter.

Running the tests

Configure the interfaces you plan to support (and targeted version of Sails/Waterline) in the adapter's package.json file:

{
  //...
  "sails": {
  	"adapter": {
	    "sailsVersion": "~0.10.0",
	    "implements": [
	      "semantic",
	      "queryable"
	    ]
	  }
  }
}

In your adapter's directory, run:

$ npm test

Publish your adapter

You're welcome to write proprietary adapters and use them any way you wish-- these instructions are for releasing an open-source adapter.

  1. Create a new public repo and add it as a remote (`git remote add origin [email protected]:yourusername/sails-youradaptername.git)

  2. Make sure you attribute yourself as the author and set the license in the package.json to "MIT".

  3. Run the tests one last time.

  4. Do a pull request to sails-docs adding your repo to data/adapters.js. Please let us know about any special instructions for usage/testing.

  5. We'll update the documentation with information about your new adapter

  6. Then everyone will adore you with lavish praises. Mike might even send you jelly beans.

  7. Run npm version patch

  8. Run git push && git push --tags

  9. Run npm publish

Questions?

See FAQ.md.

More Resources

License

MIT © 2014 balderdashy & [contributors] Mike McNeil, Balderdash & contributors

Sails is free and open-source under the MIT License.

githalytics.com alpha