word-stream - npm Package Compare versions

Comparing version 2.0.0 to 3.0.0

index.js

@@ -1,6 +0,7 @@
-'use strict';
-const fs = require('fs');
-const binarySlit = require('binary-split');
-const wordListPath = require('word-list');
+import fs from 'node:fs';
+import binarySlit from 'binary-split';
+import wordListPath from 'word-list';
 
-module.exports = fs.createReadStream(wordListPath).pipe(binarySlit());
+export default function wordStream() {
+	return fs.createReadStream(wordListPath).pipe(binarySlit());
+}

package.json

 {
-  "name": "word-stream",
-  "version": "2.0.0",
-  "description": "Returns a stream of English words",
-  "license": "MIT",
-  "repository": "sindresorhus/word-stream",
-  "author": {
-    "name": "Sindre Sorhus",
-    "email": "[e-mail]",
-    "url": "sindresorhus.com"
-  },
-  "engines": {
-    "node": ">=4"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
-  "files": [
-    "index.js"
-  ],
-  "keywords": [
-    "word",
-    "words",
-    "stream",
-    "list",
-    "en",
-    "english",
-    "dict",
-    "dictionary"
-  ],
-  "dependencies": {
-    "binary-split": "^1.0.3",
-    "word-list": "^2.0.0"
-  },
-  "devDependencies": {
-    "ava": "*",
-    "xo": "*"
-  }
+	"name": "word-stream",
+	"version": "3.0.0",
+	"description": "Returns a stream of English words",
+	"license": "MIT",
+	"repository": "sindresorhus/word-stream",
+	"funding": "https://github.com/sponsors/sindresorhus",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "[e-mail]",
+		"url": "https://sindresorhus.com"
+	},
+	"type": "module",
+	"exports": "./index.js",
+	"sideEffects": false,
+	"engines": {
+		"node": ">=18"
+	},
+	"scripts": {
+		"test": "xo && ava"
+	},
+	"files": [
+		"index.js"
+	],
+	"keywords": [
+		"word",
+		"words",
+		"stream",
+		"list",
+		"en",
+		"english",
+		"dict",
+		"dictionary"
+	],
+	"dependencies": {
+		"binary-split": "^1.0.5",
+		"word-list": "^4.0.0"
+	},
+	"devDependencies": {
+		"ava": "^6.1.2",
+		"p-event": "^6.0.1",
+		"xo": "^0.58.0"
+	}
 }

readme.md

@@ -1,2 +0,2 @@
-# word-stream [![Build Status](https://travis-ci.org/sindresorhus/word-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/word-stream)
+# word-stream
 
@@ -7,16 +7,14 @@ > Returns a stream of English words from the [Letterpress Word List](https://github.com/atebits/Words/blob/master/Words/en.txt)
 
-
 ## Install
 
+```sh
+npm install word-stream
 ```
-$ npm install --save word-stream
-```
 
-
 ## Usage
 
 ```js
-const wordStream = require('word-stream');
+import wordStream from 'word-stream';
 
-wordStream.on('data', word => {
+wordStream().on('data', word => {
 	console.log(word);
@@ -30,3 +28,2 @@ });
 
-
 ## Tip
@@ -37,14 +34,7 @@
 ```js
-const getStream = require('get-stream');
-const wordStream = require('word-stream');
+import wordStream from 'word-stream';
+import {getStreamAsArray} from 'get-stream';
 
-getStream.array(wordStream).then(words =>
-	console.log(words);
-	//=> […, 'abmhos', 'abnegate', …]
-});
+console.log(await getStreamAsArray(wordStream()));
+//=> […, 'abmhos', 'abnegate', …]
 ```
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)

New 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

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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Lines of code

6

20%

Number of low supply chain risk alerts

1

-50%

Is type module

Yes

NaN

Worsened metrics

Total package byte prevSize

2826

-3.68%

Dev dependency count

3

50%

Number of lines in readme file

38

-20.83%

Dependency changes

• + Added

  word-list@4.1.0
  (transitive)

• - Removed

  word-list@2.0.0
  (transitive)

• Updated

  binary-split@^1.0.5

• Updated

  word-list@^4.0.0