Require Node.js 18

Author: sindresorhus

.github/workflows/main.yml

@@ -10,11 +10,11 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-          - 14
-          - 12
+          - 20
+          - 18
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install

index.d.ts

@@ -1,3 +1,6 @@
+type EmptyArray = readonly never[] & {length: 0};
+type NonEmptyArray<T> = readonly [T, ...T[]] | readonly [...T[], T] | readonly [T, ...T[], T];
+
 /**
 Get consecutively unique elements from an array.
 
@@ -13,4 +16,6 @@ console.log(random(), random(), random(), random());
 //=> 4 2 1 4
 ```
 */
-export default function uniqueRandomArray<T>(array: readonly T[]): () => T;
+export default function uniqueRandomArray<T>(array: EmptyArray): () => undefined;
+export default function uniqueRandomArray<T>(array: NonEmptyArray<T>): () => T;
+export default function uniqueRandomArray<T>(array: readonly T[]): () => T | undefined;

index.js

@@ -1,6 +1,6 @@
-import uniqueRandom from 'unique-random';
+import {consecutiveUniqueRandom} from 'unique-random';
 
 export default function uniqueRandomArray(array) {
-	const random = uniqueRandom(0, array.length - 1);
+	const random = consecutiveUniqueRandom(0, array.length - 1);
 	return () => array[random()];
 }

index.test-d.ts

@@ -1,5 +1,6 @@
 import {expectType} from 'tsd';
 import uniqueRandomArray from './index.js';
 
-expectType<() => number>(uniqueRandomArray([1, 2, 3, 4]));
-expectType<() => string | number>(uniqueRandomArray(['1', 2, 3, 4]));
+expectType<number>(uniqueRandomArray([1, 2, 3, 4])());
+expectType<string | number>(uniqueRandomArray(['1', 2, 3, 4])());
+expectType<undefined>(uniqueRandomArray([])());

package.json

@@ -11,9 +11,13 @@
 		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
-	"exports": "./index.js",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
+	"sideEffects": false,
 	"engines": {
-		"node": ">=12"
+		"node": ">=18"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -34,11 +38,11 @@
 		"element"
 	],
 	"dependencies": {
-		"unique-random": "^3.0.0"
+		"unique-random": "^4.0.0"
 	},
 	"devDependencies": {
-		"ava": "^3.15.0",
-		"tsd": "^0.14.0",
-		"xo": "^0.38.2"
+		"ava": "^6.1.3",
+		"tsd": "^0.31.0",
+		"xo": "^0.58.0"
 	}
 }

readme.md

@@ -6,8 +6,8 @@ Useful for things like slideshows where you don't want to have the same slide tw
 
 ## Install
 
-```
-$ npm install unique-random-array
+```sh
+npm install unique-random-array
 ```
 
 ## Usage
@@ -25,7 +25,7 @@ console.log(random(), random(), random(), random());
 
 ### uniqueRandomArray(array)
 
-Returns a function, that when called, will return a random element that's never the same as the previous.
+Returns a function, that when called, will return a random element that's never the same as the previous, or `undefined` if the array is empty.
 
 #### array
 

test.js

@@ -13,3 +13,7 @@ test('main', t => {
 		previous = current;
 	}
 });
+
+test('empty array', t => {
+	t.is(uniqueRandomArray([])(), undefined);
+});