deleteByKey

Author: eyas-ranjous

README.md

@@ -15,7 +15,7 @@ An implementation of the round robin as a data structure. Two strategies are imp
   * [count()](#count)
   * [next()](#next)
   * [completedRounds()](#completedrounds)
-  * [delete(key)](#deletekey)
+  * [deleteByKey(key)](#deletebykeykey)
   * [reset()](#reset)
   * [clear()](#clear)
  * [Build](#build)
@@ -199,8 +199,8 @@ console.log(sequentialTable.completedRounds()); // 1
 console.log(randomTable.completedRounds()); // 1
 ```
 
-### delete(key)
-deletes an item from the table by its key.
+### deleteByKey(key)
+deletes an item by its key from the table.
 
 <table>
   <tr>

src/RandomRoundRobin.js

@@ -41,12 +41,12 @@ class RandomRoundRobin extends RoundRobin {
   }
 
   /**
-   * Deletes an item with its key from the table
+   * Deletes an item by its key from the table
    * @public
    * @param {number} key
    * @return {boolean}
    */
-  delete(key) {
+  deleteByKey(key) {
     if (!this._items.has(key)) {
       return false;
     }

src/RoundRobin.d.ts

@@ -6,7 +6,7 @@ export interface RoundRobinItem<T> {
 export class RoundRobin<T> {
   constructor(values?: T[]);
   add(value: T): RoundRobinItem<T>;
-  delete(key: number): boolean;
+  deleteByKey(key: number): boolean;
   next(): RoundRobinItem<T>;
   count(): number;
   completedRounds(): number;

src/SequentialRoundRobin.js

@@ -44,12 +44,12 @@ class SequentialRoundRobin extends RoundRobin {
   }
 
   /**
-   * Deletes an item from the table
+   * Deletes an item by its key from the table
    * @public
    * @param {number} key
    * @return {boolean}
    */
-  delete(key) {
+  deleteByKey(key) {
     if (!this._itemNodes.has(key)) {
       return false;
     }

test/RandomRoundRobin.test.js

@@ -4,15 +4,15 @@ const { RandomRoundRobin } = require('../src/RandomRoundRobin');
 describe('RandomRoundRobin tests', () => {
   const round = new RandomRoundRobin(['item 1', 'item 2']);
 
-  describe('.add', () => {
+  describe('add', () => {
     it('adds items to the round', () => {
       expect(round.add('item 3')).to.deep.equal({ key: 2, value: 'item 3' });
       expect(round.add('item 4')).to.deep.equal({ key: 3, value: 'item 4' });
       expect(round.count()).to.equal(4);
     });
   });
 
-  describe('.next', () => {
+  describe('next', () => {
     it('gets the next item in the round', () => {
       const items = [
         round.next(),
@@ -25,10 +25,10 @@ describe('RandomRoundRobin tests', () => {
     });
   });
 
-  describe('.delete', () => {
+  describe('deleteByKey', () => {
     it('removes items from the round', () => {
-      round.delete(0);
-      round.delete(2);
+      round.deleteByKey(0);
+      round.deleteByKey(2);
       expect(round.count()).to.equal(2);
 
       const items = [
@@ -40,14 +40,14 @@ describe('RandomRoundRobin tests', () => {
     });
   });
 
-  describe('.reset', () => {
+  describe('reset', () => {
     it('reset the round', () => {
       round.reset();
       expect(round.count()).to.equal(2);
     });
   });
 
-  describe('.clear', () => {
+  describe('clear', () => {
     it('clears the round', () => {
       round.clear();
       expect(round.count()).to.equal(0);

test/SequentialRoundRobin.test.js

@@ -4,15 +4,15 @@ const { SequentialRoundRobin } = require('../src/SequentialRoundRobin');
 describe('SequentialRoundRobin tests', () => {
   const round = new SequentialRoundRobin(['item 1', 'item 2']);
 
-  describe('.add', () => {
+  describe('add', () => {
     it('adds items to the round', () => {
       expect(round.add('item 3')).to.deep.equal({ key: 2, value: 'item 3' });
       expect(round.add('item 4')).to.deep.equal({ key: 3, value: 'item 4' });
       expect(round.count()).to.equal(4);
     });
   });
 
-  describe('.next', () => {
+  describe('next', () => {
     it('gets the next item in the round', () => {
       const next1 = round.next();
       expect(next1.key).to.equal(0);
@@ -37,10 +37,10 @@ describe('SequentialRoundRobin tests', () => {
     });
   });
 
-  describe('.delete', () => {
+  describe('delete', () => {
     it('removes items from the round', () => {
-      round.delete(1);
-      round.delete(3);
+      round.deleteByKey(1);
+      round.deleteByKey(3);
       expect(round.count()).to.equal(2);
 
       const next1 = round.next();
@@ -66,7 +66,7 @@ describe('SequentialRoundRobin tests', () => {
     });
   });
 
-  describe('.reset', () => {
+  describe('reset', () => {
     it('reset the round', () => {
       round.reset();
       expect(round.count()).to.equal(2);
@@ -81,7 +81,7 @@ describe('SequentialRoundRobin tests', () => {
     });
   });
 
-  describe('.clear', () => {
+  describe('clear', () => {
     it('clears the round', () => {
       round.clear();
       expect(round.count()).to.equal(0);