Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@types/vinyl-fs

Package Overview
Dependencies
Maintainers
1
Versions
42
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/vinyl-fs - npm Package Compare versions

Comparing version 0.3.3 to 0.3.4

228

vinyl-fs v0.3/index.d.ts

@@ -10,136 +10,136 @@ // Type definitions for vinyl-fs 0.3

declare global {
namespace NodeJS {
interface WritableStream {
write(buffer: any/* Vinyl.File */, cb?: (err?: Error | null) => void): boolean;
}
}
namespace NodeJS {
interface WritableStream {
write(buffer: any, /* Vinyl.File */ cb?: (err?: Error | null) => void): boolean;
}
}
}
import * as _events from 'events';
import * as File from 'vinyl';
import * as globStream from 'glob-stream';
import * as _events from "events";
import * as globStream from "glob-stream";
import * as File from "vinyl";
export interface SrcOptions extends globStream.Options {
/** Prevents stream from emitting an error when file not found. */
allowEmpty?: boolean | undefined;
/** Prevents stream from emitting an error when file not found. */
allowEmpty?: boolean | undefined;
/** Specifies the working directory the folder is relative to */
cwd?: string | undefined;
/** Specifies the working directory the folder is relative to */
cwd?: string | undefined;
/**
* Specifies the folder relative to the cwd
* This is used to determine the file names when saving in .dest()
* Default: where the glob begins
*/
base?: string | undefined;
/**
* Specifies the folder relative to the cwd
* This is used to determine the file names when saving in .dest()
* Default: where the glob begins
*/
base?: string | undefined;
/**
* Setting this to false will make file.contents a paused stream
* If true it will buffer the file contents
* Default: true
*/
buffer?: boolean | undefined;
/**
* Setting this to false will make file.contents a paused stream
* If true it will buffer the file contents
* Default: true
*/
buffer?: boolean | undefined;
/**
* The mode the directory should be created with.
* Default: the process mode
*/
dirMode?: number | undefined;
/**
* The mode the directory should be created with.
* Default: the process mode
*/
dirMode?: number | undefined;
/**
* Whether or not you want globs to match on dot files or not
* (e.g., `.gitignore`).
*/
dot?: boolean | undefined;
/**
* Whether or not you want globs to match on dot files or not
* (e.g., `.gitignore`).
*/
dot?: boolean | undefined;
/**
* Whether or not to recursively resolve symlinks to their targets.
* Setting to `false` to preserve them as symlinks and make `file.symlink`
* equal the original symlink's target path.
* Default: true
*/
followSymlinks?: boolean | undefined;
/**
* Whether or not to recursively resolve symlinks to their targets.
* Setting to `false` to preserve them as symlinks and make `file.symlink`
* equal the original symlink's target path.
* Default: true
*/
followSymlinks?: boolean | undefined;
/**
* Setting this to false will ignore the contents of the file and disable
* writing to disk to speed up operations
* Default: true
*/
read?: boolean | undefined;
/**
* Setting this to false will ignore the contents of the file and disable
* writing to disk to speed up operations
* Default: true
*/
read?: boolean | undefined;
/**
* Whether or not the symlink should be relative or absolute.
* Default: false
*/
relative?: boolean | undefined;
/**
* Whether or not the symlink should be relative or absolute.
* Default: false
*/
relative?: boolean | undefined;
/** Only find files that have been modified since the time specified */
since?: Date|number | undefined;
/** Only find files that have been modified since the time specified */
since?: Date | number | undefined;
/**
* Causes the BOM to be stripped on UTF-8 encoded files. Set to `false`
* if you need the BOM for some reason.
*/
stripBOM?: boolean | undefined;
/**
* Causes the BOM to be stripped on UTF-8 encoded files. Set to `false`
* if you need the BOM for some reason.
*/
stripBOM?: boolean | undefined;
/**
* Setting this to true will create a duplex stream, one that passes
* through items and emits globbed files.
* Default: false
*/
passthrough?: boolean | undefined;
/**
* Setting this to true will create a duplex stream, one that passes
* through items and emits globbed files.
* Default: false
*/
passthrough?: boolean | undefined;
/**
* Setting this to true will enable sourcemaps.
* Default: false
*/
sourcemaps?: boolean | undefined;
/**
* Setting this to true will enable sourcemaps.
* Default: false
*/
sourcemaps?: boolean | undefined;
/**
* Whether or not to recursively resolve symlinks to their targets. Setting to false to
* preserve them as symlinks and make file.symlink equal the original symlink's target path.
* Default: false
*/
resolveSymlinks?: boolean | undefined;
/**
* Causes the BOM to be removed on UTF-8 encoded files. Set to false if you need the BOM for some reason.
* Default: true
*/
removeBOM?: boolean | undefined;
/**
* Whether or not to recursively resolve symlinks to their targets. Setting to false to
* preserve them as symlinks and make file.symlink equal the original symlink's target path.
* Default: false
*/
resolveSymlinks?: boolean | undefined;
/**
* Causes the BOM to be removed on UTF-8 encoded files. Set to false if you need the BOM for some reason.
* Default: true
*/
removeBOM?: boolean | undefined;
}
export interface DestOptions {
/**
* Specify the working directory the folder is relative to
* Default is process.cwd()
*/
cwd?: string | undefined;
/**
* Specify the working directory the folder is relative to
* Default is process.cwd()
*/
cwd?: string | undefined;
/**
* Specify the mode the files should be created with
* Default is the mode of the input file (file.stat.mode)
* or the process mode if the input file has no mode property
*/
mode?: number|string | undefined;
/**
* Specify the mode the files should be created with
* Default is the mode of the input file (file.stat.mode)
* or the process mode if the input file has no mode property
*/
mode?: number | string | undefined;
/** Specify the mode the directory should be created with. Default is the process mode */
dirMode?: number|string | undefined;
/** Specify the mode the directory should be created with. Default is the process mode */
dirMode?: number | string | undefined;
/** Specify if existing files with the same path should be overwritten or not. Default is true, to always overwrite existing files */
overwrite?: boolean | undefined;
/** Specify if existing files with the same path should be overwritten or not. Default is true, to always overwrite existing files */
overwrite?: boolean | undefined;
/**
* Enables sourcemap support on files passed through the stream. Will write inline soucemaps if
* specified as true. Specifying a string path will write external sourcemaps at the given path.
*/
sourcemaps?: true | string | undefined;
/**
* Enables sourcemap support on files passed through the stream. Will write inline soucemaps if
* specified as true. Specifying a string path will write external sourcemaps at the given path.
*/
sourcemaps?: true | string | undefined;
/**
* When creating a symlink, whether or not the created symlink should be relative. If false,
* the symlink will be absolute. Note: This option will be ignored if a junction is being created.
*/
relativeSymlinks?: boolean | undefined;
/**
* When creating a symlink, whether or not the created symlink should be relative. If false,
* the symlink will be absolute. Note: This option will be ignored if a junction is being created.
*/
relativeSymlinks?: boolean | undefined;
/* When creating a symlink, whether or not a directory symlink should be created as a junction. */
useJunctions?: boolean | undefined;
/* When creating a symlink, whether or not a directory symlink should be created as a junction. */
useJunctions?: boolean | undefined;
}

@@ -154,3 +154,3 @@

*/
export function src(globs: string|string[], opt?: SrcOptions): NodeJS.ReadWriteStream;
export function src(globs: string | string[], opt?: SrcOptions): NodeJS.ReadWriteStream;

@@ -164,3 +164,6 @@ /**

*/
export function watch(globs: string|string[], cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter;
export function watch(
globs: string | string[],
cb?: (outEvt: { type: any; path: any; old: any }) => void,
): _events.EventEmitter;

@@ -175,3 +178,3 @@ /**

export function watch(
globs: string|string[],
globs: string | string[],
opt?: {

@@ -183,3 +186,4 @@ interval?: number | undefined;

},
cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter;
cb?: (outEvt: { type: any; path: any; old: any }) => void,
): _events.EventEmitter;

@@ -186,0 +190,0 @@ /**

{
"name": "@types/vinyl-fs",
"version": "0.3.3",
"version": "0.3.4",
"description": "TypeScript definitions for vinyl-fs",

@@ -32,4 +32,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/vinyl-fs",

},
"typesPublisherContentHash": "d32223f04bda6e011066a53614be5002a7a37a316797d80b5533fbf09738166a",
"typeScriptVersion": "4.3"
"typesPublisherContentHash": "665a4ee4dc7660850bcf557edf5a70d9c91904d1d718c9f098f38aa81f690bc2",
"typeScriptVersion": "4.5"
}

@@ -11,3 +11,3 @@ # Installation

### Additional Details
* Last updated: Fri, 05 May 2023 17:32:59 GMT
* Last updated: Tue, 26 Sep 2023 10:06:28 GMT
* Dependencies: [@types/glob-stream](https://npmjs.com/package/@types/glob-stream), [@types/node](https://npmjs.com/package/@types/node), [@types/vinyl](https://npmjs.com/package/@types/vinyl)

@@ -14,0 +14,0 @@ * Global values: none

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc