Git Product home page Git Product logo

kingpin's Introduction

Kingpin

Better Immutable.js Records

Installation

Install via npm as a dependency:

$ npm install kingpin --save

Getting Started

Complete example

import Kingpin, {schema} from 'kingpin';

@schema({ name: String })
class Author extends Kingpin {
  firstName() {
    return this.name.split(' ')[0];
  }
}

@schema({
  title: String,
  user: [Object, null],
  authors: Array(Author),
  createdAt: Date,
})
class Post extends Kingpin {
}

@schema({
  title: [String, null] // make the title optional
})
class GamePost extends Post {
}

const gamePost = new GamePost({
  title: 'GTA',
  user: null, // optional
  authors: [{ name: 'John Doe' }],
  createdAt: '2015-01-01',
});

console.log(gamePost.title); // => GTA
console.log(gamePost.user); // => null
console.log(gamePost.createdAt); // => Thu Jan 01 2015 02:00:00 GMT+0200 (EET)
console.log(gamePost.authors[0].firstName()); // => John

Development

$ npm install

Tests

$ npm test

License

MIT (Product Hunt Inc.)

kingpin's People

Contributors

vesln avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.