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 2.4.9 to 2.4.10

286

vinyl-fs/index.d.ts

@@ -5,2 +5,3 @@ // Type definitions for vinyl-fs 2.4

// remisery <https://github.com/remisery>
// TeamworkGuy2 <https://github.com/TeamworkGuy2>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

@@ -11,7 +12,7 @@

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;
}
}
}

@@ -24,124 +25,124 @@

export interface SrcOptions extends globStream.Options {
/** Prevents stream from emitting an error when file not found. */
allowEmpty?: boolean;
/** Prevents stream from emitting an error when file not found. */
allowEmpty?: boolean;
/** Specifies the working directory the folder is relative to */
cwd?: string;
/** Specifies the working directory the folder is relative to */
cwd?: string;
/**
* 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;
/**
* 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;
/**
* Setting this to false will make file.contents a paused stream
* If true it will buffer the file contents
* Default: true
*/
buffer?: boolean;
/**
* Setting this to false will make file.contents a paused stream
* If true it will buffer the file contents
* Default: true
*/
buffer?: boolean;
/**
* The mode the directory should be created with.
* Default: the process mode
*/
dirMode?: number;
/**
* The mode the directory should be created with.
* Default: the process mode
*/
dirMode?: number;
/**
* Whether or not you want globs to match on dot files or not
* (e.g., `.gitignore`).
*/
dot?: boolean;
/**
* Whether or not you want globs to match on dot files or not
* (e.g., `.gitignore`).
*/
dot?: boolean;
/**
* 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;
/**
* 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;
/**
* Setting this to false will ignore the contents of the file and disable
* writing to disk to speed up operations
* Default: true
*/
read?: boolean;
/**
* Setting this to false will ignore the contents of the file and disable
* writing to disk to speed up operations
* Default: true
*/
read?: boolean;
/**
* Whether or not the symlink should be relative or absolute.
* Default: false
*/
relative?: boolean;
/**
* Whether or not the symlink should be relative or absolute.
* Default: false
*/
relative?: boolean;
/** Only find files that have been modified since the time specified */
since?: Date|number;
/** Only find files that have been modified since the time specified */
since?: Date | number;
/**
* Causes the BOM to be stripped on UTF-8 encoded files. Set to `false`
* if you need the BOM for some reason.
*/
stripBOM?: boolean;
/**
* Causes the BOM to be stripped on UTF-8 encoded files. Set to `false`
* if you need the BOM for some reason.
*/
stripBOM?: boolean;
/**
* Setting this to true will create a duplex stream, one that passes
* through items and emits globbed files.
* Default: false
*/
passthrough?: boolean;
/**
* Setting this to true will create a duplex stream, one that passes
* through items and emits globbed files.
* Default: false
*/
passthrough?: boolean;
/**
* Setting this to true will enable sourcemaps.
* Default: false
*/
sourcemaps?: boolean;
/**
* Setting this to true will enable sourcemaps.
* Default: false
*/
sourcemaps?: boolean;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
}
export interface DestOptions {
/**
* Specify the working directory the folder is relative to
* Default is process.cwd()
*/
cwd?: string;
/**
* Specify the working directory the folder is relative to
* Default is process.cwd()
*/
cwd?: string;
/**
* 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;
/**
* 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;
/** Specify the mode the directory should be created with. Default is the process mode */
dirMode?: number|string;
/** Specify the mode the directory should be created with. Default is the process mode */
dirMode?: number | string;
/** Specify if existing files with the same path should be overwritten or not. Default is true, to always overwrite existing files */
overwrite?: boolean;
/** Specify if existing files with the same path should be overwritten or not. Default is true, to always overwrite existing files */
overwrite?: boolean;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* 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;
/* When creating a symlink, whether or not a directory symlink should be created as a junction. */
useJunctions?: boolean;
/* When creating a symlink, whether or not a directory symlink should be created as a junction. */
useJunctions?: boolean;
}

@@ -159,28 +160,2 @@

/**
* This is just a glob-watcher
*
* @param globs Takes a glob string or an array of glob strings as the first argument
* Globs are executed in order, so negations should follow positive globs
* fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js'])
*/
export function watch(globs: string|string[], cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter;
/**
* This is just a glob-watcher
*
* @param globs Takes a glob string or an array of glob strings as the first argument
* Globs are executed in order, so negations should follow positive globs
* fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js'])
*/
export function watch(
globs: string|string[],
opt?: {
interval?: number;
debounceDelay?: number;
cwd?: string;
maxListeners?(): number;
},
cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter;
/**
* On write the stream will save the vinyl File to disk at the folder/cwd specified.

@@ -214,16 +189,16 @@ * After writing the file to disk, it will be emitted from the stream so you can keep piping these around.

export function symlink(folder: string, opts?: {
/**
* Specify the working directory the folder is relative to
* Default is process.cwd()
*/
cwd?: string;
/**
* Specify the working directory the folder is relative to
* Default is process.cwd()
*/
cwd?: string;
/** Specify the mode the directory should be created with. Default is the process mode */
mode?: number|string;
/** Specify the mode the directory should be created with. Default is the process mode */
mode?: number | string;
/**
* Specify the mode the directory should be created with
* Default is the process mode
*/
dirMode?: number
/**
* Specify the mode the directory should be created with
* Default is the process mode
*/
dirMode?: number
}): NodeJS.ReadWriteStream;

@@ -237,15 +212,14 @@

*/
export function symlink(getFolderPath: (File: File) => string, opts?:
{
/**
* Specify the working directory the folder is relative to
* Default is process.cwd()
*/
cwd?: string;
export function symlink(getFolderPath: (File: File) => string, opts?: {
/**
* Specify the working directory the folder is relative to
* Default is process.cwd()
*/
cwd?: string;
/**
* Specify the mode the directory should be created with
* Default is the process mode
*/
dirMode?: number
}): NodeJS.ReadWriteStream;
/**
* Specify the mode the directory should be created with
* Default is the process mode
*/
dirMode?: number
}): NodeJS.ReadWriteStream;
{
"name": "@types/vinyl-fs",
"version": "2.4.9",
"version": "2.4.10",
"description": "TypeScript definitions for vinyl-fs",

@@ -16,5 +16,11 @@ "license": "MIT",

"githubUsername": "remisery"
},
{
"name": "TeamworkGuy2",
"url": "https://github.com/TeamworkGuy2",
"githubUsername": "TeamworkGuy2"
}
],
"main": "",
"types": "index",
"repository": {

@@ -26,9 +32,8 @@ "type": "git",

"dependencies": {
"@types/events": "*",
"@types/vinyl": "*",
"@types/glob-stream": "*",
"@types/node": "*"
"@types/node": "*",
"@types/vinyl": "*"
},
"typesPublisherContentHash": "d39ec5b20eb7330f71412efd58f6ea4a53f1b5cf92b2f35a126489cae112efbf",
"typesPublisherContentHash": "207f502d96a52d4e6e7de3d291bdf2de808acf1ccfc13cab47fe89f9be46ea0f",
"typeScriptVersion": "2.0"
}

@@ -5,3 +5,3 @@ # Installation

# Summary
This package contains type definitions for vinyl-fs (https://github.com/wearefractal/vinyl-fs).
This package contains type definitions for vinyl-fs ( https://github.com/wearefractal/vinyl-fs ).

@@ -12,7 +12,7 @@ # Details

Additional Details
* Last updated: Sat, 04 Aug 2018 00:56:33 GMT
* Dependencies: events, vinyl, glob-stream, node
* Last updated: Tue, 29 Jan 2019 18:10:11 GMT
* Dependencies: @types/vinyl, @types/glob-stream, @types/node
* Global values: none
# Credits
These definitions were written by vvakame <https://github.com/vvakame>, remisery <https://github.com/remisery>.
These definitions were written by vvakame <https://github.com/vvakame>, remisery <https://github.com/remisery>, TeamworkGuy2 <https://github.com/TeamworkGuy2>.

Sorry, the diff of this file is not supported yet

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