Giter Club home page Giter Club logo

immutable-model's Introduction

Immutable Model and Collection Classes

Immutable Model and Collection classes for node or web.

Installation

Use npm to install:

npm install caldera-immutable-model

Usage

The Model and Collection classes are data structures that wrap javascript objects and arrays, respectively.

Model

Method Description
toJS() Returns a plain javascript object representing the data
get(key: string) -> any Returns the value for a key
set(key: string, value: any) -> Model Returns a new Model with the key/value pair
remove(key: string) -> Model Returns a new Model with the key/value removed
setIn(keyPath: [string], value: any) -> Model Returns a new Model with the keyPath set
getIn(keyPath: [string]) -> any Returns the value at the keyPath

Collection

Method Description
toJS() Returns a plain javascript object representing the data
get(index: number) -> any Returns the value at an index
set(index: number, value: any) -> Model Returns a new Collection with the index/value pair
push(value: any) -> Model Returns a new Collection with the value pushed
toArray() -> [any] Returns a new Collection with the value pushed
remove(predicate) -> Collection Returns a new Collection with any values removed where predicate returns true

Copyright and License

Code and documentation copyright 2017 Jon Brennecke. Code released under the MIT license. Docs released under Creative Commons.

immutable-model's People

Contributors

jonbrennecke avatar

Stargazers

Josh Pollock avatar Brett Berry avatar  avatar

Watchers

James Cloos 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.