/ih

WIP.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

PersistenceJS

PersistenceJS provides specialized, immutable, persistent data structures built on-top of ImmutableJS. PersistenceJS offers highly efficient immutable linked-lists, heaps, and search trees, with more data structures coming soon.

Current Stable Release Version Codeship Status for PersistenceJS Current Stable npm Release

Immutable data cannot be changed once created... Persistent data presents a mutative API which does not update the data in-place, but instead always yields new updated data (source).

To learn more about immutable data, persistent data structures, or any of the individual data structures implemented by PersistenceJS, please explore the appendix.

Created by Clark Feusier and Daniel Tsui

  1. Dependencies
  2. Installation
  3. Documentation
  4. Roadmap
  5. Contributing
  6. Development Requirements
    1. Installing Dependencies
    2. Running Tests
  7. License
  8. Appendix

Dependencies

  • immutable — basic immutable collections on which PersistenceJS is constructed
  • core-js — ES5/6/7 polyfills, shims, and other goodies

Installation

PersistenceJS is available as an npm package.

Install module from command-line

npm install persistence-js

Require module for use in desired file

var Persist = require('persistence-js');

Documentation

PersistenceJS

This object provides all of the data structures offered by PersistenceJS.

var Persist = require('persistence-js');

Data Structures

var LList = Persist.LinkedList;
var exampleLList = new LList();
var CLList = Persist.CircularLinkedList;
var exampleCLList = new CLList();
var Heap = Persist.Heap;
var exampleHeap = new Heap();
var BSTree = Persist.BSTree;
var exampleBST = new BSTree();

Roadmap

The future of PersistenceJS is managed through this repository's issues — view the roadmap here.

Contributing to PersistenceJS

We welcome contributions, but please read our contribution guidelines before submitting your work. The development requirements and instructions are below.

Development Requirements

  • Node 0.10.x
  • npm 2.x.x
  • core-js
  • immutable
  • babel (global install)
  • babel-jest
  • jest-cli (global install)
  • grunt (global install)
  • grunt-cli (global install)
  • load-grunt-tasks
  • grunt-babel

Installing Dependencies

Install Node (bundled with npm) using Homebrew:

brew install node

Install project and development dependencies using npm:

npm install

Running Tests

After installing the above dependencies, tests can be run using the following command:

npm test

License

PersistenceJS - specialized persistent collections in javascript

Copyright 2015 Clark Feusier & Sze-Hung Daniel Tsui

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

COMPLETE LICENSE

Appendix

Persistence

A persistent data structure ... always preserves the previous version of itself when modified.

Immutability

An immutable object is an object whose state cannot be modified after it is created.

Note, persistent data structures are generally immutable, since the API returns a new structure, despite appearing mutable.

Back to Top