Page MenuHomeSealhub
Files F21588695

README.md
No OneTemporary
Actions

Authored By
Unknown
Size
2 KB
Referenced Files
None
Subscribers
None

README.md
View Options

# Set
string sets for javascript
This library can be used as a shim for [EcmaScript Harmony’s Set
class](http://wiki.ecmascript.org/doku.php?id=harmony:simple_maps_and_sets#set).
## Installation
For the server:
npm install Set
For the browser:
ender build Set
## Usage
~~~ javascript
var Set = require('Set');
var alpha = new Set([ 'a', 'b', 'c' ]);
console.log(alpha.toString());
alpha.add('d');
console.log(alpha.toString());
alpha.remove('a', 'b');
console.log(alpha.toString());
console.log(alpha.contains('c'));
~~~
## API
~~~ javascript
new Set(obj)
~~~
Create a set from an array or object.
~~~ javascript
new Set(contains)
~~~
Create a set from a function.
This good for creating infinite sets. `contains` is a function that takes one
argument and returns `true` if it is in the set and `false` otherwise. It works
well together with `set.add()` and `set.remove()`, but not with `set.toArray()`
and `set.toString()`.
~~~ javascript
set.add(val, ...)
~~~
Add one or more elements to the set.
~~~ javascript
set.addAll(array)
~~~
Add all elements from array to the set.
~~~ javascript
set.remove(val, ...)
set.['delete'](val)
~~~
Remove one or more elements from the set.
~~~ javascript
set.contains(val)
set.has(val)
~~~
Check if the set contains `val`.
~~~ javascript
set.size()
~~~
Returns the size of the set.
~~~ javascript
set.toArray()
set['*values']()
~~~
Returns the elements of the set as an Array.
~~~ javascript
set.toString()
~~~
Serialize the set.
## License
~~~
Copyright © 2012 Paul Vorbach
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the “Software”), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
~~~

File Metadata

Mime Type
application/javascript
Expires
Sat, Nov 7, 14:47 (20 h, 1 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1181825
Default Alt Text
README.md (2 KB)

Event Timeline