🚧 progress: Import existing sources, tests, and code samples.

Author: make-github-pseudonymous-again

README.md

@@ -4,13 +4,16 @@
 Item repetition for JavaScript.
 See [docs](https://iterable-iterator.github.io/repeat/index.html).
 
-> :building_construction: Caveat emptor! This is work in progress. Code may be
-> working. Documentation may be present. Coherence may be. Maybe.
-
 > :warning: Depending on your environment, the code may require
 > `regeneratorRuntime` to be defined, for instance by importing
 > [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
 
+```js
+import {repeat, nrepeat} from '@iterable-iterator/repeat';
+repeat("A"); // A A A ...
+nrepeat("A", 3); // A A A
+```
+
 [![License](https://img.shields.io/github/license/iterable-iterator/repeat.svg)](https://raw.githubusercontent.com/iterable-iterator/repeat/main/LICENSE)
 [![Version](https://img.shields.io/npm/v/@iterable-iterator/repeat.svg)](https://www.npmjs.org/package/@iterable-iterator/repeat)
 [![Tests](https://img.shields.io/github/workflow/status/iterable-iterator/repeat/ci:test?event=push&label=tests)](https://github.com/iterable-iterator/repeat/actions/workflows/ci:test.yml?query=branch:main)

package.json

@@ -67,6 +67,8 @@
     "@babel/preset-env": "7.13.15",
     "@babel/register": "7.13.16",
     "@commitlint/cli": "12.1.1",
+    "@iterable-iterator/list": "^0.0.2",
+    "@iterable-iterator/slice": "^0.0.1",
     "@js-library/commitlint-config": "0.0.4",
     "ava": "3.15.0",
     "babel-plugin-transform-remove-console": "6.9.4",

src/index.js

@@ -1,2 +1,2 @@
-const answer = 42;
-export default answer;
+export {default as nrepeat} from './nrepeat.js';
+export {default as repeat} from './repeat.js';

src/nrepeat.js

@@ -0,0 +1,16 @@
+/**
+ * Repeats the input item a few times. Returns an iterator that yields the input
+ * item a fixed number of times.
+ *
+ * @example
+ * list( nrepeat( 6 , 3 ) ) ; // returns [ 6 , 6 , 6 ]
+ *
+ * @param {any} item - The input item.
+ * @param {Number} times - The number of times to yield <code>item</code>.
+ * @returns {IterableIterator}
+ */
+export default function* nrepeat(item, times) {
+	while (times-- > 0) {
+		yield item;
+	}
+}

src/repeat.js

@@ -0,0 +1,15 @@
+/**
+ * Repeats the input item endlessly. Returns an iterator that yields the input
+ * item over and over again.
+ *
+ * @example
+ * list( take( repeat( 6 ) , 3 ) ) ; // returns [ 6 , 6 , 6 ]
+ *
+ * @param {Object} item - The input item.
+ * @returns {Iterator}
+ */
+export default function* repeat(item) {
+	while (true) {
+		yield item;
+	}
+}

test/src/api.js

@@ -0,0 +1,27 @@
+import test from 'ava';
+
+import {list} from '@iterable-iterator/list';
+import {nrepeat} from '../../src/index.js';
+
+test('nrepeat', (t) => {
+	const x = function (item, times, expected) {
+		t.deepEqual(list(nrepeat(item, times)), expected);
+	};
+
+	for (const item of [
+		0,
+		1,
+		-1,
+		[],
+		'A',
+		'ABC',
+		['A'],
+		[0, 1, -1],
+		['A', 'B', 'C'],
+	]) {
+		x(item, 0, []);
+		x(item, 1, [item]);
+		x(item, 2, [item, item]);
+		x(item, 3, [item, item, item]);
+	}
+});

test/src/nrepeat.js

@@ -0,0 +1,28 @@
+import test from 'ava';
+
+import {list} from '@iterable-iterator/list';
+import {head} from '@iterable-iterator/slice';
+import {repeat} from '../../src/index.js';
+
+test('repeat', (t) => {
+	const x = function (item, times, expected) {
+		t.deepEqual(list(head(repeat(item), times)), expected);
+	};
+
+	for (const item of [
+		0,
+		1,
+		-1,
+		[],
+		'A',
+		'ABC',
+		['A'],
+		[0, 1, -1],
+		['A', 'B', 'C'],
+	]) {
+		x(item, 0, []);
+		x(item, 1, [item]);
+		x(item, 2, [item, item]);
+		x(item, 3, [item, item, item]);
+	}
+});