data.list

Immutable list

Example

( ... )

Installing

The easiest way is to grab it from NPM. If you're running in a Browser environment, you can use Browserify

$ npm install data.list

Using with CommonJS

If you're not using NPM, Download the latest release, and require the data.list.umd.js file:

var List = require('data.list')

Using with AMD

Download the latest release, and require the data.list.umd.js file:

require(['data.list'], function(List) {
  ( ... )
})

Using without modules

Download the latest release, and load the data.list.umd.js file. The properties are exposed in the global folktale.data.List object:

<script src="/path/to/data.list.umd.js"></script>

Compiling from source

If you want to compile this library from the source, you'll need Git, Make, Node.js, and run the following commands:

$ git clone git://github.com/folktale/data.list.git
$ cd data.list
$ npm install
$ make bundle

This will generate the dist/data.list.umd.js file, which you can load in any JavaScript environment.

Documentation

You can read the documentation online or build it yourself:

$ git clone git://github.com/folktale/data.list.git
$ cd data.list
$ npm install
$ make documentation

Then open the file docs/literate/index.html in your browser.

Platform support

This library assumes an ES5 environment, but can be easily supported in ES3 platforms by the use of shims. Just include es5-shim :)

Licence

Copyright (c) 2013 Quildreen Motta.

Released under the MIT licence.