📚 docs: Document api.

Author: make-github-pseudonymous-again

src/_deque.js

@@ -1,11 +1,25 @@
 import {TypeError, ValueError} from '@aureooms/js-error';
 
+/**
+ * _deque.
+ *
+ * @param {Deque} UnboundedDeque
+ * @param {Deque} BoundedDeque
+ * @param {Deque} SingleElementDeque
+ * @param {Deque} EmptyDeque
+ */
 export default function _deque(
 	UnboundedDeque,
 	BoundedDeque,
 	SingleElementDeque,
 	EmptyDeque,
 ) {
+	/**
+	 * Deque.
+	 *
+	 * @param {Iterable<any>} iterable
+	 * @param {Number} maxlen
+	 */
 	const deque = (iterable = null, maxlen = null) => {
 		if (maxlen === null) {
 			return new UnboundedDeque(iterable);

src/implementation/ArbitrarySizeDeque.js

@@ -1,5 +1,8 @@
 import Deque from './Deque.js';
 
+/**
+ * ArbitrarySizeDeque.
+ */
 export default function ArbitrarySizeDeque() {}
 
 ArbitrarySizeDeque.prototype = new Deque();

src/implementation/BoundedDeque.js

@@ -1,5 +1,11 @@
 import ArbitrarySizeDeque from './ArbitrarySizeDeque.js';
 
+/**
+ * BoundedDeque.
+ *
+ * @param {Iterable<any>} iterable
+ * @param {Number} maxlen
+ */
 export default function BoundedDeque(iterable, maxlen) {
 	this._maxlen = maxlen;
 
@@ -73,6 +79,13 @@ BoundedDeque.prototype._where = function (i) {
 	return [this._container, (this._center + i) % this._maxlen];
 };
 
+/**
+ * BoundedDeque.prototype._popindex.
+ *
+ * @param {any} container
+ * @param {Number} index
+ * @return {any}
+ */
 BoundedDeque.prototype._popindex = function (container, index) {
 	const value = container[index];
 

src/implementation/Deque.js

@@ -1,43 +1,97 @@
 import {NotImplementedError, IndexError, ValueError} from '@aureooms/js-error';
 
+/**
+ * Deque.
+ */
 export default function Deque() {}
 
+/**
+ * Deque.prototype.len.
+ *
+ * @return {Number}
+ */
 Deque.prototype.len = function () {
 	throw new NotImplementedError('len');
 };
 
+/**
+ * Deque.prototype.capacity.
+ *
+ * @return {Number}
+ */
 Deque.prototype.capacity = function () {
 	throw new NotImplementedError('capcity');
 };
 
+/**
+ * Deque.prototype.empty.
+ *
+ * @return {Boolean}
+ */
 Deque.prototype.empty = function () {
 	return this.len() === 0;
 };
 
+/**
+ * Deque.prototype[Symbol.iterator].
+ *
+ * @return {Iterable<any>}
+ */
 Deque.prototype[Symbol.iterator] = function () {
 	return this.values();
 };
 
+/**
+ * Deque.prototype.values.
+ *
+ * @return {Iterable<any>}
+ */
 Deque.prototype.values = function () {
 	throw new NotImplementedError('values');
 };
 
+/**
+ * Deque.prototype.append.
+ *
+ * @param {any} _x
+ */
 Deque.prototype.append = function (_x) {
 	throw new NotImplementedError('append');
 };
 
+/**
+ * Deque.prototype.appendleft.
+ *
+ * @param {any} _x
+ */
 Deque.prototype.appendleft = function (_x) {
 	throw new NotImplementedError('appendleft');
 };
 
+/**
+ * Deque.prototype.clear.
+ *
+ * @return {Deque}
+ */
 Deque.prototype.clear = function () {
 	throw new NotImplementedError('clear');
 };
 
+/**
+ * Deque.prototype.copy.
+ *
+ * @return {Deque}
+ */
 Deque.prototype.copy = function () {
 	throw new NotImplementedError('copy');
 };
 
+/**
+ * Deque.prototype.count.
+ *
+ * @param {any} x
+ * @return {Number}
+ */
 Deque.prototype.count = function (x) {
 	let c = 0;
 
@@ -50,6 +104,11 @@ Deque.prototype.count = function (x) {
 	return c;
 };
 
+/**
+ * Deque.prototype.extend.
+ *
+ * @param {Iterable<any>} iterable
+ */
 Deque.prototype.extend = function (iterable) {
 	for (const x of iterable) {
 		this.append(x);
@@ -58,6 +117,11 @@ Deque.prototype.extend = function (iterable) {
 	return this;
 };
 
+/**
+ * Deque.prototype.extendleft.
+ *
+ * @param {Iterable<any>} iterable
+ */
 Deque.prototype.extendleft = function (iterable) {
 	for (const x of iterable) {
 		this.appendleft(x);
@@ -66,22 +130,46 @@ Deque.prototype.extendleft = function (iterable) {
 	return this;
 };
 
+/**
+ * Deque.prototype._checkbounds.
+ *
+ * @param {Number} i
+ */
 Deque.prototype._checkbounds = function (i) {
 	if (i < 0 || i >= this.len()) {
 		throw new IndexError(i);
 	}
 };
 
+/**
+ * Deque.prototype._where.
+ *
+ * @param {Number} _i
+ * @return {Array}
+ */
 Deque.prototype._where = function (_i) {
 	throw new NotImplementedError('_where');
 };
 
+/**
+ * Deque.prototype.get.
+ *
+ * @param {Number} i
+ * @return {any}
+ */
 Deque.prototype.get = function (i) {
 	const [container, index] = this._where(i);
 
 	return container[index];
 };
 
+/**
+ * Deque.prototype.set.
+ *
+ * @param {Number} i
+ * @param {any} value
+ * @return {Deque}
+ */
 Deque.prototype.set = function (i, value) {
 	const [container, index] = this._where(i);
 
@@ -90,12 +178,26 @@ Deque.prototype.set = function (i, value) {
 	return this;
 };
 
+/**
+ * Deque.prototype._range
+ *
+ * @param {Number} start
+ * @param {Number} stop
+ * @return {Iterable<any>}
+ */
 Deque.prototype._range = function* (start, stop) {
 	for (let i = start; i < stop; ++i) {
 		yield [i, this.get(i)];
 	}
 };
 
+/**
+ * Deque.prototype.index.
+ *
+ * @param {any} x
+ * @param {Number} start
+ * @param {Number} stop
+ */
 Deque.prototype.index = function (x, start = 0, stop = this.len()) {
 	for (const [i, element] of this._range(start, stop)) {
 		if (element === x) {
@@ -106,14 +208,30 @@ Deque.prototype.index = function (x, start = 0, stop = this.len()) {
 	throw new ValueError('not found');
 };
 
+/**
+ * Deque.prototype.pop.
+ *
+ * @return {any}
+ */
 Deque.prototype.pop = function () {
 	throw new NotImplementedError('pop');
 };
 
+/**
+ * Deque.prototype.popleft.
+ *
+ * @return {any}
+ */
 Deque.prototype.popleft = function () {
 	throw new NotImplementedError('popleft');
 };
 
+/**
+ * Deque.prototype.insert.
+ *
+ * @param {Number} i
+ * @param {any} x
+ */
 Deque.prototype.insert = function (i, x) {
 	this._checkbounds(i);
 
@@ -130,6 +248,11 @@ Deque.prototype.insert = function (i, x) {
 	return this;
 };
 
+/**
+ * Deque.prototype.delete.
+ *
+ * @param {Number} i
+ */
 Deque.prototype.delete = function (i) {
 	this._checkbounds(i);
 
@@ -144,6 +267,11 @@ Deque.prototype.delete = function (i) {
 	return this;
 };
 
+/**
+ * Deque.prototype.remove.
+ *
+ * @param {any} value
+ */
 Deque.prototype.remove = function (value) {
 	const i = this.index(value);
 
@@ -152,6 +280,11 @@ Deque.prototype.remove = function (value) {
 	return this;
 };
 
+/**
+ * Deque.prototype.reverse.
+ *
+ * @return {Deque}
+ */
 Deque.prototype.reverse = function () {
 	for (let i = 0, j = this.len(); i < --j; ++i) {
 		const a = this.get(i);
@@ -163,6 +296,11 @@ Deque.prototype.reverse = function () {
 	return this;
 };
 
+/**
+ * Deque.prototype.rotate.
+ *
+ * @param {Number} n
+ */
 Deque.prototype.rotate = function (n) {
 	if (n > 0) {
 		while (n-- > 0) {

src/implementation/EmptyDeque.js

@@ -1,6 +1,11 @@
 import {IndexError} from '@aureooms/js-error';
 import Deque from './Deque.js';
 
+/**
+ * EmptyDeque.
+ *
+ * @param {Iterable<any>} iterable
+ */
 export default function EmptyDeque(iterable) {
 	if (iterable !== null) {
 		this.extend(iterable);

src/implementation/SingleElementDeque.js

@@ -1,6 +1,11 @@
 import {IndexError} from '@aureooms/js-error';
 import Deque from './Deque.js';
 
+/**
+ * SingleElementDeque.
+ *
+ * @param {Iterable<any>} iterable
+ */
 export default function SingleElementDeque(iterable) {
 	this._empty = true;
 

src/implementation/UnboundedDeque.js

@@ -1,5 +1,10 @@
 import ArbitrarySizeDeque from './ArbitrarySizeDeque.js';
 
+/**
+ * UnboundedDeque.
+ *
+ * @param {Iterable<any>} iterable
+ */
 export default function UnboundedDeque(iterable) {
 	this._growth = 2;