reverse-iterable-map
Advanced tools
Comparing version 1.1.5 to 2.0.0
{ | ||
"name": "reverse-iterable-map", | ||
"version": "1.1.5", | ||
"version": "2.0.0", | ||
"description": "A reverse-iterable map implementation based on the built-in Map object", | ||
@@ -21,3 +21,4 @@ "main": "./src/reverse-iterable-map", | ||
"reverse-iterable", | ||
"iterable-iterator" | ||
"iterable", | ||
"iterator" | ||
], | ||
@@ -24,0 +25,0 @@ "author": { |
@@ -93,2 +93,4 @@ # reverse-iterable-map | ||
### Constructor | ||
@@ -104,3 +106,3 @@ | ||
* `iterable`: An [iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol) oject whose elements are key-value pairs. | ||
* `iterable`: An [iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol) object whose elements are key-value pairs. | ||
@@ -134,2 +136,4 @@ In order to construct a `ReverseIterableMap` object from an array, it can be passed by calling the [`Array.prototype.entries()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/entries) method. | ||
### `clear()` | ||
@@ -155,2 +159,4 @@ | ||
### `has()` | ||
@@ -175,3 +181,3 @@ | ||
```js | ||
const map = new ReverseIterableMap(['hey', 'beauty']); | ||
const map = new ReverseIterableMap(['hey', 'beauty'].entries()); | ||
@@ -188,2 +194,4 @@ map.has(0); | ||
### `get()` | ||
@@ -208,3 +216,3 @@ | ||
```js | ||
const map = new ReverseIterableMap(['hey', 'beauty']); | ||
const map = new ReverseIterableMap(['hey', 'beauty'].entries()); | ||
@@ -221,54 +229,4 @@ map.get(0); | ||
### `getLast()` | ||
#### Syntax | ||
``` | ||
map.getLast(); | ||
``` | ||
**Return value**: | ||
* Returns the last element or `null` if the map is empty. | ||
#### Usage | ||
```js | ||
const map = new ReverseIterableMap(); | ||
map.getLast(); | ||
//> null | ||
map.set('key-chain', 'beauty'); | ||
map.getLast(); | ||
//> 'beauty' | ||
``` | ||
### `getFirst()` | ||
#### Syntax | ||
``` | ||
map.getLast(); | ||
``` | ||
**Return value**: | ||
* Returns the first element or `null` if the map is empty. | ||
#### Usage | ||
```js | ||
const map = new ReverseIterableMap(); | ||
map.getFirst(); | ||
//> null | ||
map.set('the-magic-key', 'hey'); | ||
map.getFirst(); | ||
//> 'hey' | ||
``` | ||
### `set()` | ||
@@ -296,6 +254,6 @@ | ||
map.set('key-chain', 'hey'); | ||
map.set('you', 'beauty'); | ||
//> map | ||
map.set('the-magic-key', 'beauty'); | ||
map.set('the-magic-key', 'hey'); | ||
//> map | ||
@@ -312,2 +270,4 @@ ``` | ||
### `setFirst()` | ||
@@ -336,12 +296,14 @@ | ||
const map = new ReverseIterableMap() | ||
.setFirst('one-t', 'the-magic-key') | ||
.setFirst('featuring', 'cool-t'); | ||
.setFirst('key1', 'was inserted first') | ||
.setFirst('key2', 'was inserted last'); | ||
map.getFirst(); | ||
//> 'cool-t' | ||
//> 'was inserted last' | ||
map.getLast(); | ||
//> 'the-magic-key' | ||
//> 'was inserted first' | ||
``` | ||
### `delete()` | ||
@@ -366,3 +328,3 @@ | ||
```js | ||
const map = new ReverseIterableMap(['hey', 'beauty']); | ||
const map = new ReverseIterableMap(['hey', 'beauty'].entries()); | ||
@@ -379,2 +341,4 @@ map.delete(0); | ||
### `forEach()` | ||
@@ -399,2 +363,4 @@ | ||
### `forEachReverse()` | ||
@@ -419,2 +385,4 @@ | ||
### `[Symbol.iterator]()` | ||
@@ -454,2 +422,4 @@ | ||
### `reverse()` | ||
@@ -489,2 +459,4 @@ | ||
### `entries()` | ||
@@ -506,2 +478,4 @@ | ||
### `keys()` | ||
@@ -523,2 +497,4 @@ | ||
### `values()` | ||
@@ -540,2 +516,4 @@ | ||
### `iteratorFor()` | ||
@@ -542,0 +520,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
48566
869
607