@types/glob-stream - npm Package Compare versions

Comparing version 6.1.0 to 6.1.1

glob-stream/index.d.ts

@@ -29,3 +29,3 @@ // Type definitions for glob-stream v6.1.0
          */
-        allowEmpty?: boolean;
+        allowEmpty?: boolean | undefined;
         /**
@@ -35,7 +35,7 @@ * The absolute segment of the glob path that isn't a glob. This value is attached
          */
-        base?: string;
+        base?: string | undefined;
         /**
          * Whether or not the `cwd` and `base` should be the same.
          */
-        cwdbase?: boolean;
+        cwdbase?: boolean | undefined;
         /**
@@ -46,3 +46,3 @@ * Filters stream to remove duplicates based on the string property name or the result of function.
          */
-        uniqueBy?: UniqueByStringPredicate | UniqueByFunctionPredicate;
+        uniqueBy?: UniqueByStringPredicate | UniqueByFunctionPredicate | undefined;
     }
@@ -49,0 +49,0 @@ }

glob-stream/package.json

 {
     "name": "@types/glob-stream",
-    "version": "6.1.0",
+    "version": "6.1.1",
     "description": "TypeScript definitions for glob-stream",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/glob-stream",
     "license": "MIT",
@@ -19,5 +20,7 @@ "contributors": [
     "main": "",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://www.github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/glob-stream"
     },
@@ -29,4 +32,4 @@ "scripts": {},
     },
-    "typesPublisherContentHash": "d888c0282cd1d7508084d08c8349730835c134896e0bdab1c31ffe71ea446acf",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "4f95abbc262d29e7b6845db3fd66080652aaad2f73a2069c4984128e99ad7e9c",
+    "typeScriptVersion": "3.6"
 }

glob-stream/README.md

@@ -8,10 +8,62 @@ # Installation
 # Details
-Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/glob-stream
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/glob-stream.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/glob-stream/index.d.ts)
+````ts
+// Type definitions for glob-stream v6.1.0
+// Project: https://github.com/wearefractal/glob-stream
+// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
+//                 mrmlnc <https://github.com/mrmlnc>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
-Additional Details
- * Last updated: Sun, 03 Dec 2017 16:26:41 GMT
- * Dependencies: glob, node
+/// <reference types="node" />
+/// <reference types="glob" />
+
+import glob = require('glob');
+
+declare function GlobStream(glob: string | string[]): NodeJS.ReadableStream;
+declare function GlobStream(glob: string | string[], options: GlobStream.Options): NodeJS.ReadableStream;
+
+declare namespace GlobStream {
+    export interface Entry {
+        cwd: string;
+        base: string;
+        path: string;
+    }
+
+    export type UniqueByStringPredicate = 'cwd' | 'base' | 'path';
+    export type UniqueByFunctionPredicate = (entry: Entry) => string;
+
+    export interface Options extends glob.IOptions {
+        /**
+         * Whether or not to error upon an empty singular glob.
+         */
+        allowEmpty?: boolean | undefined;
+        /**
+         * The absolute segment of the glob path that isn't a glob. This value is attached
+         * to each globobject and is useful for relative pathing.
+         */
+        base?: string | undefined;
+        /**
+         * Whether or not the `cwd` and `base` should be the same.
+         */
+        cwdbase?: boolean | undefined;
+        /**
+         * Filters stream to remove duplicates based on the string property name or the result of function.
+         * When using a function, the function receives the streamed
+         * data (objects containing `cwd`, `base`, `path` properties) to compare against.
+         */
+        uniqueBy?: UniqueByStringPredicate | UniqueByFunctionPredicate | undefined;
+    }
+}
+
+export = GlobStream;
+
+````
+
+### Additional Details
+ * Last updated: Tue, 06 Jul 2021 20:33:05 GMT
+ * Dependencies: [@types/glob](https://npmjs.com/package/@types/glob), [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 
 # Credits
-These definitions were written by Bart van der Schoor <https://github.com/Bartvds>, mrmlnc <https://github.com/mrmlnc>.
+These definitions were written by [Bart van der Schoor](https://github.com/Bartvds), and [mrmlnc](https://github.com/mrmlnc).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6475

increased by51.21%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

69

increased by305.88%

No dependency changes