Updated to be ecmascript module.

Committing version 1.0.0

Author: Steve Thompson

.gitignore

@@ -9,7 +9,7 @@
 /node_modules
 
 # IDEs and editors
-/.idea
+.idea/
 .project
 .classpath
 .c9/

.npmignore

@@ -1,3 +1,4 @@
 lib/
 .idea/
 dist/tests.js
+tsconfig.json

README.md

@@ -4,7 +4,7 @@ Paginates the data in `array`.
 `array` is never modified.
 
 ## Examples
-```ts
+```js
 let arr = [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20];
 
 console.log(getPage(1, 5, arr));
@@ -35,11 +35,8 @@ console.log(getPage(2, 19, arr));
 `npm i  @writetome51/array-get-page`
 
 ## Loading
-```ts
-// if using TypeScript:
+```js
 import { getPage } from '@writetome51/array-get-page';
-// if using ES5 JavaScript:
-var getPage = require('@writetome51/array-get-page').getPage;
 ```
 
 

dist/index.js

@@ -1,32 +1,41 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const array_get_adjacent_at_1 = require("@writetome51/array-get-adjacent-at");
-const get_rounded_up_down_1 = require("@writetome51/get-rounded-up-down");
-const array_get_head_tail_1 = require("@writetome51/array-get-head-tail");
-const in_range_1 = require("@writetome51/in-range");
-const not_1 = require("@writetome51/not");
-function getPage(pageNumber, itemsPerPage, array) {
-    errorIfRequestedPageDoesNotExist(pageNumber);
-    const firstIndexToGet = (itemsPerPage * (pageNumber - 1));
-    if (isLastPage(pageNumber))
-        return getRemainingItems(firstIndexToGet);
-    else
-        return array_get_adjacent_at_1.getAdjacentAt(firstIndexToGet, itemsPerPage, array);
-    function errorIfRequestedPageDoesNotExist(pageNumber) {
-        let totalPages = getTotalPages();
-        if (totalPages === 0 || not_1.not(in_range_1.inRange([1, totalPages], pageNumber))) {
-            throw new Error('The requested page does not exist');
-        }
-    }
-    function getTotalPages() {
-        return get_rounded_up_down_1.getRoundedUp(array.length / itemsPerPage);
-    }
-    function isLastPage(pageNumber) {
-        return (pageNumber === getTotalPages());
-    }
-    function getRemainingItems(firstIndexToGet) {
-        let numItemsToGet = (array.length - firstIndexToGet);
-        return array_get_head_tail_1.getTail(numItemsToGet, array);
-    }
+import {getAdjacentAt} from '@writetome51/array-get-adjacent-at';
+import {getRoundedUp} from '@writetome51/get-rounded-up-down';
+import {getTail} from '@writetome51/array-get-head-tail';
+import {inRange} from '@writetome51/in-range';
+import {not} from '@writetome51/not';
+
+
+export function getPage(pageNumber, itemsPerPage, array) {
+
+	errorIfRequestedPageDoesNotExist(pageNumber);
+
+	const firstIndexToGet = (itemsPerPage * (pageNumber - 1));
+
+	if (isLastPage(pageNumber)) return getRemainingItems(firstIndexToGet);
+	else return getAdjacentAt(firstIndexToGet, itemsPerPage, array);
+
+
+	function errorIfRequestedPageDoesNotExist(pageNumber) {
+		let totalPages = getTotalPages();
+		if (totalPages === 0 || not(inRange([1, totalPages], pageNumber))) {
+			throw new Error('The requested page does not exist');
+		}
+	}
+
+
+	function getTotalPages() {
+		return getRoundedUp(array.length / itemsPerPage);
+	}
+
+
+	function isLastPage(pageNumber) {
+		return (pageNumber === getTotalPages());
+	}
+
+
+	function getRemainingItems(firstIndexToGet) {
+		let numItemsToGet = (array.length - firstIndexToGet);
+		return getTail(numItemsToGet, array);
+	}
+
 }
-exports.getPage = getPage;

dist/tests.js

@@ -1,20 +1,99 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./index");
+import {getPage} from './index.js';
+import {arraysMatch} from '@writetome51/arrays-match';
+
+
+let result = getPage(1, 1, [1]);
+if (arraysMatch(result, [1])) console.log('test 1 passed');
+else console.log('test 1 FAILED');
+
+
 let arr = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20];
-console.log(index_1.getPage(1, 5, arr));
-// --> [1,2,3,4,5]
-console.log(index_1.getPage(2, 5, arr));
-// --> [6,7,8,9,10]
-console.log(index_1.getPage(1, 7, arr));
-// --> [1,2,3,4,5,6,7]
-console.log(index_1.getPage(3, 7, arr));
-// --> [15,16,17,18,19,20]
-console.log(index_1.getPage(1, 19, arr));
-// --> [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19]
-console.log(index_1.getPage(2, 19, arr));
-// --> [20]
-// console.log(getPage(4, 7, arr));
-// --> 'Error: The requested page does not exist'
-// console.log(getPage(4, 7, 'abcdefghijklmnopqrstuvwxyz'));
-// --> 'Error: Input must be array.'
+result = getPage(1, 5, arr);
+if (arraysMatch(result, [1, 2, 3, 4, 5])) console.log('test 2 passed');
+else console.log('test 2 FAILED');
+
+
+result = getPage(2, 5, arr);
+if (arraysMatch(result, [6, 7, 8, 9, 10])) console.log('test 3 passed');
+else console.log('test 3 FAILED');
+
+
+result = getPage(1, 7, arr);
+if (arraysMatch(result, [1, 2, 3, 4, 5, 6, 7])) console.log('test 4 passed');
+else console.log('test 4 FAILED');
+
+
+result = getPage(3, 7, arr);
+if (arraysMatch(result, [15, 16, 17, 18, 19, 20])) console.log('test 5 passed');
+else console.log('test 5 FAILED');
+
+
+result = getPage(1, 19, arr);
+if (arraysMatch(result, [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]))
+	console.log('test 6 passed');
+else console.log('test 6 FAILED');
+
+
+result = getPage(2, 19, arr);
+if (arraysMatch(result, [20])) console.log('test 7 passed');
+else console.log('test 7 FAILED');
+
+
+let errTriggered = false;
+try {
+	getPage(4, 7, arr);
+} catch (e) {
+	errTriggered = true;
+}
+if (errTriggered) console.log('test 8 passed');
+else console.log('test 8 FAILED');
+
+
+errTriggered = false;
+try {
+	getPage(1, 5, 'abcdefghijklmnopqrstuvwxyz');
+} catch (e) {
+	errTriggered = true;
+}
+if (errTriggered) console.log('test 9 passed');
+else console.log('test 9 FAILED');
+
+
+errTriggered = false;
+try {
+	getPage(1, 1, []);
+} catch (e) {
+	errTriggered = true;
+}
+if (errTriggered) console.log('test 10 passed');
+else console.log('test 10 FAILED');
+
+
+errTriggered = false;
+try {
+	getPage(-1, 1, [1]);
+} catch (e) {
+	errTriggered = true;
+}
+if (errTriggered) console.log('test 11 passed');
+else console.log('test 11 FAILED');
+
+
+errTriggered = false;
+try {
+	getPage(1, 0, [1]);
+} catch (e) {
+	errTriggered = true;
+}
+if (errTriggered) console.log('test 12 passed');
+else console.log('test 12 FAILED');
+
+
+errTriggered = false;
+try {
+	getPage(1, -1, [1]);
+} catch (e) {
+	errTriggered = true;
+}
+if (errTriggered) console.log('test 13 passed');
+else console.log('test 13 FAILED');