@types/glob-stream
- Version 6.1.1
- Published
- 6.47 kB
- 2 dependencies
- MIT license
Install
npm i @types/glob-stream
yarn add @types/glob-stream
pnpm add @types/glob-stream
Overview
TypeScript definitions for glob-stream
Index
Functions
Interfaces
Type Aliases
Functions
function GlobStream
GlobStream: { (glob: string | string[]): NodeJS.ReadableStream; (glob: string | string[], options: GlobStream.Options): NodeJS.ReadableStream;};
Interfaces
interface Entry
interface Entry {}
interface Options
interface Options extends glob.IOptions {}
property allowEmpty
allowEmpty?: boolean | undefined;
Whether or not to error upon an empty singular glob.
property base
base?: string | 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.
property cwdbase
cwdbase?: boolean | undefined;
Whether or not the
cwd
andbase
should be the same.
property uniqueBy
uniqueBy?: UniqueByStringPredicate | UniqueByFunctionPredicate | 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.
Type Aliases
type UniqueByFunctionPredicate
type UniqueByFunctionPredicate = (entry: Entry) => string;
type UniqueByStringPredicate
type UniqueByStringPredicate = 'cwd' | 'base' | 'path';
Package Files (1)
Dependencies (2)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/glob-stream
.
- Markdown[](https://www.jsdocs.io/package/@types/glob-stream)
- HTML<a href="https://www.jsdocs.io/package/@types/glob-stream"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1353 ms. - Missing or incorrect documentation? Open an issue for this package.