Enable all Set-like iterator methods

README.md

@@ -30,19 +30,21 @@ npm install @blakeembrey/deque --save
 * `delete(i)` Delete the value at position `i`.
 * `reverse()` Reverse the elements of the deque in-place.
 * `rotate(n=1)` Rotate the deque `n` steps to the right.
+* `entries()` Return an iterable of deque.
+* `@@iterator()` Return an iterable of deque.
 
 ```js
 import { Deque } from '@blakeembrey/deque'
 
 const d = new Deque('ghi')
 
-for (const elem of d) {
-  console.log(elem.toUpperCase()) //=> G H I
+for (const value of d) {
+  console.log(value.toUpperCase()) //=> G H I
 }
 
 d.push('j')
 d.pushleft('f')
-d //=> deque(['f', 'g', 'h', 'i', 'j'])
+d //=> Deque(['f', 'g', 'h', 'i', 'j'])
 
 d.pop() //=> 'j'
 d.popleft() //=> 'f'
@@ -53,13 +55,17 @@ d.peek(0) //=> 'g'
 d.peek(-1) //=> 'i'
 
 d.extend('jkl')
-d //=> deque(['g', 'h', 'i', 'j', 'k', 'l'])
+d //=> Deque(['g', 'h', 'i', 'j', 'k', 'l'])
 
 d.rotate(1)
-d //=> deque(['l', 'g', 'h', 'i', 'j', 'k'])
+d //=> Deque(['l', 'g', 'h', 'i', 'j', 'k'])
 
 d.rotate(-1)
-d //=> deque(['g', 'h', 'i', 'j', 'k', 'l'])
+d //=> Deque(['g', 'h', 'i', 'j', 'k', 'l'])
+
+const d2 = new Deque(d)
+
+d2 //=> Deque(['g', 'h', 'i', 'j', 'k', 'l'])
 ```
 
 ## TypeScript

src/index.spec.ts

@@ -8,11 +8,12 @@ describe('values', () => {
     expect(values).toEqual(Array.from('abc'))
   })
 
-  it('should support values method', () => {
+  it('should support `Set`-like iterable methods', () => {
     const d = new Deque('abc')
-    const values = Array.from(d.values())
 
-    expect(values).toEqual(Array.from('abc'))
+    expect(Array.from(d.entries())).toEqual(Array.from('abc'))
+    expect(Array.from(d.keys())).toEqual(Array.from('abc'))
+    expect(Array.from(d.values())).toEqual(Array.from('abc'))
   })
 })
 

src/index.ts

@@ -204,13 +204,21 @@ export class Deque<T> {
     return this
   }
 
-  *values() {
+  *entries(): IterableIterator<T> {
     const { head, size, list, mask } = this
 
     for (let i = 0; i < size; i++) yield list[(head + i) & mask]
   }
 
+  keys() {
+    return this.entries()
+  }
+
+  values() {
+    return this.entries()
+  }
+
   [Symbol.iterator]() {
-    return this.values()
+    return this.entries()
   }
 }