https://github.com/emberjs/ember-ordered-set
https://github.com/emberjs/ember-ordered-set
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/emberjs/ember-ordered-set
- Owner: emberjs
- License: mit
- Created: 2017-11-05T20:57:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:46:59.000Z (over 3 years ago)
- Last Synced: 2024-10-29T14:50:05.691Z (over 1 year ago)
- Language: JavaScript
- Size: 2.62 MB
- Stars: 3
- Watchers: 10
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
ember-ordered-set
==============================================================================
[](https://www.npmjs.com/package/@ember/ordered-set)
[](https://travis-ci.org/emberjs/ember-ordered-set)
The `OrderedSet` class lets you store unique values of any type, whether
primitive values or object references. It is mostly similar to the native
[`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)
class introduced in ES2015.
Compatibility
------------------------------------------------------------------------------
* Ember.js v3.8 or above
* Ember CLI v2.13 or above
* Node.js v10 or above
Installation
------------------------------------------------------------------------------
```
ember install @ember/ordered-set
```
Usage
------------------------------------------------------------------------------
After installing you can import `OrderedSet` from `@ember/ordered-set`:
```js
import OrderedSet from '@ember/ordered-set';
```
The `OrderedSet` class has mostly the same API as the native [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)
class with a few differences:
- The constructor does not take any arguments
- A static `create()` method exists for symmetry with `Ember.Object`
- A static `length` property does not exist on `OrderedSet`
- `OrderedSet` has an `isEmpty()` method
- There are no `entries()`, `keys()` and `values()` methods, but there is a
`toArray()` method instead
- The `@@iterator` symbol is not defined
- `OrderedSet` has a `copy()` method
Contributing
------------------------------------------------------------------------------
See the [Contributing](CONTRIBUTING.md) guide for details.
License
------------------------------------------------------------------------------
ember-ordered-set is licensed under the [MIT License](LICENSE.md).