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

datacore

v0.3.0

Published

Data model for RESTful API clients, made dead simple.

Downloads

1

Readme

Description

Data model for RESTful API clients, made simple. In essence, an ES6 class with support for typed schemas, CRUD methods with schema conversion, and inheritance helpers for ES5 environments. Straightforward, lightweight, and has good code coverage via tests and Flow.

This has seen a complete rewrite. I've slimmed the library down tremendously to focus on the most vital features. See 1.0.x to compare.

Datacore is packaged in a format compatible with both AngularJS and CommonJS.

Why Bother?

Rich web applications consume and generate lots of data. It's common to organise it by breaking it up into well-defined "models" that correspond to resources on a RESTful API backend. A model library handles the boilerplate code so you don't have to.

Installation

AngularJS

Install via bower:

bower i --save datacore
# or
bower i --save-dev datacore

The angular build uses $q and $http instead of es6-promise and xhttp, but still depends on lodash. Make sure you have window._ available.

You'll need main-bower-files in your build system to organise dependency order. Datacore specifies angular and lodash as dependencies but doesn't bundle them. main-bower-files makes sure they'll be loaded in the right order.

In your app's configuration, require the module and factory Datacore.

// ES5
angular.module('MyApp', ['Datacore'])
.factory('Record', ['Datacore', function(Datacore) {

  // Your base model.
  var Record = Datacore.derive('Record');

  // Base URL to your server.
  Record.prototype.$path = function() {return '/my-api-url'};

  // Example schema.
  Record.prototype.$schema = {
    id: '',
    value: null
  }

  return Record;

}]);

// ES6
angular.module('MyApp', ['Datacore'])
.factory('Record', ['Datacore', function(Datacore) {

  // Your base model.
  class Record extends Datacore {
    // Base URL to your server.
    $path() {return '/my-api-url'}

    // Example schema (immutable).
    get $schema() {return {
      id: '',
      value: null
    }}
  }

  return Record;

}]);

CommonJS

To use CommonJS, you need a build system with browserify or webpack.

Install via npm:

npm i --save-dev datacore

Then require in your application:

var Datacore = require('datacore');

See basic configuration above.

ToDo / WIP.

The documentation needs a complete rewrite now.