random-item - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

index.d.ts

+/**
+Get a random item from an [Iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol).
+
+@example
+```
+import randomItem = require('random-item');
+
+randomItem(['🐴', '🦄', '🌈']);
+//=> '🦄'
+
+randomItem(new Set(['🐴', '🦄', '🌈']);
+//=> '🌈'
+```
+*/
+declare function randomItem<T>(input: Iterable<T>): T;
+
+export = randomItem;

index.js

 'use strict';
-module.exports = function (arr) {
-	if (!Array.isArray(arr)) {
-		throw new TypeError('Expected an array');
+
+module.exports = iterable => {
+	if (!Array.isArray(iterable) && typeof iterable[Symbol.iterator] !== 'function') {
+		throw new TypeError('Expected an array or an iterable');
 	}
 
-	return arr[Math.floor(Math.random() * arr.length)];
+	const array = Array.isArray(iterable) ? iterable : [...iterable];
+
+	return array[Math.floor(Math.random() * array.length)];
 };

package.json

 {
-  "name": "random-item",
-  "version": "1.0.0",
-  "description": "Get a random item from an array",
-  "license": "MIT",
-  "repository": "sindresorhus/random-item",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "[e-mail]",
-    "url": "sindresorhus.com"
-  },
-  "engines": {
-    "node": ">=0.10.0"
-  },
-  "scripts": {
-    "test": "node test.js"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "rand",
-    "random",
-    "randomize",
-    "math",
-    "array",
-    "arr",
-    "item",
-    "el",
-    "element",
-    "pick",
-    "select"
-  ],
-  "devDependencies": {
-    "ava": "0.0.4",
-    "stable-fn": "^1.0.0"
-  }
+	"name": "random-item",
+	"version": "2.0.0",
+	"description": "Get a random item from an Iterable",
+	"license": "MIT",
+	"repository": "sindresorhus/random-item",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "[e-mail]",
+		"url": "sindresorhus.com"
+	},
+	"engines": {
+		"node": ">=8"
+	},
+	"scripts": {
+		"test": "xo && ava && tsd"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
+	"keywords": [
+		"random",
+		"randomize",
+		"math",
+		"array",
+		"iterable",
+		"item",
+		"element",
+		"pick",
+		"select"
+	],
+	"devDependencies": {
+		"ava": "^1.4.1",
+		"stable-fn": "^2.0.0",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
+	}
 }

readme.md

 # random-item [![Build Status](https://travis-ci.org/sindresorhus/random-item.svg?branch=master)](https://travis-ci.org/sindresorhus/random-item)
 
-> Get a random item from an array
+> Get a random item from an [Iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol)
 
@@ -9,3 +9,3 @@
 ```
-$ npm install --save random-item
+$ npm install random-item
 ```
@@ -17,6 +17,9 @@
 ```js
-var randomItem = require('random-item');
+const randomItem = require('random-item');
 
-randomItem(['pony', 'unicorn', 'rainbow']);
-//=> 'unicorn'
+randomItem(['🐴', '🦄', '🌈']);
+//=> '🦄'
+
+randomItem(new Set(['🐴', '🦄', '🌈']);
+//=> '🌈'
 ```
@@ -33,2 +36,3 @@
 - [unique-random-array](https://github.com/sindresorhus/unique-random-array) - Get consecutively unique elements from an array
+- [crypto-random-string](https://github.com/sindresorhus/crypto-random-string) - Generate a cryptographically strong random string
 
@@ -38,2 +42,2 @@
 
-MIT © [Sindre Sorhus](http://sindresorhus.com)
+MIT © [Sindre Sorhus](https://sindresorhus.com)

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3823

27.05%

Number of package files

5

25%

Lines of code

21

200%

Number of lines in readme file

40

11.11%

Number of medium supply chain risk alerts

0

-100%

Worsened metrics

Dev dependency count

4

100%

No dependency changes