Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@types/vinyl-fs
Advanced tools
@types/vinyl-fs - npm Package Compare versions
Comparing version 2.4.12 to 3.0.0
@@ -1,2 +0,2 @@ | ||
| // Type definitions for vinyl-fs 2.4 | ||
| // Type definitions for vinyl-fs 3.0 | ||
| // Project: https://github.com/gulpjs/vinyl-fs | ||
@@ -23,16 +23,3 @@ // Definitions by: vvakame <https://github.com/vvakame> | ||
| export interface SrcOptions extends globStream.Options { | ||
| /** 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 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 | ||
@@ -42,25 +29,5 @@ * If true it will buffer the file contents | ||
| */ | ||
| buffer?: boolean | undefined; | ||
| buffer?: boolean | ((file: File) => boolean) | 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 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 | ||
@@ -70,25 +37,15 @@ * writing to disk to speed up operations | ||
| */ | ||
| read?: boolean | undefined; | ||
| read?: boolean | ((file: File) => 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; | ||
| since?: Date | number | ((file: File) => 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. | ||
| * Causes the BOM to be removed on UTF-8 encoded files. Set to false if you need the BOM for some reason. | ||
| * Default: true | ||
| */ | ||
| stripBOM?: boolean | undefined; | ||
| removeBOM?: boolean | ((file: File) => 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; | ||
| /** Optionally transcode from the given encoding. The default is 'utf8'. */ | ||
| encoding?: string | false | ((file: File) => string | false) | undefined; | ||
@@ -99,3 +56,3 @@ /** | ||
| */ | ||
| sourcemaps?: boolean | undefined; | ||
| sourcemaps?: boolean | ((file: File) => boolean) | undefined; | ||
@@ -107,8 +64,3 @@ /** | ||
| */ | ||
| 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; | ||
| resolveSymlinks?: boolean | ((file: File) => boolean) | undefined; | ||
| } | ||
@@ -121,3 +73,3 @@ | ||
| */ | ||
| cwd?: string | undefined; | ||
| cwd?: string | ((file: File) => string) | undefined; | ||
@@ -129,10 +81,16 @@ /** | ||
| */ | ||
| mode?: number | string | undefined; | ||
| mode?: number | ((file: File) => number) | undefined; | ||
| /** Specify the mode the directory should be created with. Default is the process mode */ | ||
| dirMode?: number | string | undefined; | ||
| dirMode?: number | ((file: File) => number) | 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; | ||
| overwrite?: boolean | ((file: File) => boolean) | undefined; | ||
| /** Whether or not new data should be appended after existing file contents (if any). Default is false, to always replace existing contents */ | ||
| append?: boolean | ((file: File) => boolean) | undefined; | ||
| /** Optionally transcode to the given encoding. The default is 'utf8'. */ | ||
| encoding?: string | false | ((file: File) => string | false) | undefined; | ||
| /** | ||
@@ -142,3 +100,3 @@ * Enables sourcemap support on files passed through the stream. Will write inline soucemaps if | ||
| */ | ||
| sourcemaps?: true | string | undefined; | ||
| sourcemaps?: boolean | string | ((file: File) => string | false | undefined) | undefined; | ||
@@ -149,6 +107,6 @@ /** | ||
| */ | ||
| relativeSymlinks?: boolean | undefined; | ||
| relativeSymlinks?: boolean | ((file: File) => boolean) | undefined; | ||
| /* When creating a symlink, whether or not a directory symlink should be created as a junction. */ | ||
| useJunctions?: boolean | undefined; | ||
| useJunctions?: boolean | ((file: File) => boolean) | undefined; | ||
| } | ||
@@ -172,18 +130,7 @@ | ||
| * contents will have it's position reset to the beginning if it is a stream | ||
| * @param folder destination folder | ||
| * @param folder destination folder or a function that takes in a file and returns a folder path | ||
| */ | ||
| export function dest(folder: string, opt?: DestOptions): NodeJS.ReadWriteStream; | ||
| export function dest(folder: string | ((file: File) => string), opt?: DestOptions): NodeJS.ReadWriteStream; | ||
| /** | ||
| * On write the stream will save the vinyl File to disk at the folder/cwd specified. | ||
| * After writing the file to disk, it will be emitted from the stream so you can keep piping these around. | ||
| * The file will be modified after being written to this stream: | ||
| * cwd, base, and path will be overwritten to match the folder | ||
| * stat.mode will be overwritten if you used a mode parameter | ||
| * contents will have it's position reset to the beginning if it is a stream | ||
| * @param getFolderPath function that takes in a file and returns a folder path | ||
| */ | ||
| export function dest(getFolderPath: (file: File) => string): NodeJS.ReadWriteStream; | ||
| /** | ||
| * On write the stream will create a symbolic link (i.e. symlink) on disk at the folder/cwd specified. | ||
@@ -194,3 +141,3 @@ * After creating the symbolic link, it will be emitted from the stream so you can keep piping these around. | ||
| */ | ||
| export function symlink(folder: string, opts?: { | ||
| export function symlink(folder: string | ((File: File) => string), opts?: { | ||
| /** | ||
@@ -200,7 +147,4 @@ * Specify the working directory the folder is relative to | ||
| */ | ||
| cwd?: string | undefined; | ||
| cwd?: string | ((file: File) => string) | undefined; | ||
| /** Specify the mode the directory should be created with. Default is the process mode */ | ||
| mode?: number | string | undefined; | ||
| /** | ||
@@ -210,23 +154,15 @@ * Specify the mode the directory should be created with | ||
| */ | ||
| dirMode?: number | undefined | ||
| }): NodeJS.ReadWriteStream; | ||
| dirMode?: number | ((file: File) => number) | undefined; | ||
| /** | ||
| * On write the stream will create a symbolic link (i.e. symlink) on disk at the folder/cwd generated from getFolderPath. | ||
| * After creating the symbolic link, it will be emitted from the stream so you can keep piping these around. | ||
| * The file will be modified after being written to this stream: | ||
| * cwd, base, and path will be overwritten to match the folder | ||
| */ | ||
| export function symlink(getFolderPath: (File: File) => string, opts?: { | ||
| /** Specify if existing files with the same path should be overwritten or not. Default is true, to always overwrite existing files */ | ||
| overwrite?: boolean | ((file: File) => boolean) | undefined; | ||
| /** | ||
| * Specify the working directory the folder is relative to | ||
| * Default is process.cwd() | ||
| * Specify whether the symlink should be relative or absolute. | ||
| * Default is false. | ||
| */ | ||
| cwd?: string | undefined; | ||
| relativeSymlinks?: boolean | ((file: File) => boolean) | undefined; | ||
| /** | ||
| * Specify the mode the directory should be created with | ||
| * Default is the process mode | ||
| */ | ||
| dirMode?: number | undefined | ||
| /* When creating a symlink, whether or not a directory symlink should be created as a junction. */ | ||
| useJunctions?: boolean | ((file: File) => boolean) | undefined; | ||
| }): NodeJS.ReadWriteStream; |
| { | ||
| "name": "@types/vinyl-fs", | ||
| "version": "2.4.12", | ||
| "version": "3.0.0", | ||
| "description": "TypeScript definitions for vinyl-fs", | ||
@@ -37,4 +37,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/vinyl-fs", | ||
| }, | ||
| "typesPublisherContentHash": "cd6f5abd07e92d900139c88023db12af89d7ca5344e8e7c393294bee72434778", | ||
| "typeScriptVersion": "3.6" | ||
| "typesPublisherContentHash": "efcba6c3c91cb89899ed13bc2939adc064588268b527dbf9ae340e65413595fc", | ||
| "typeScriptVersion": "4.2" | ||
| } |
@@ -11,4 +11,4 @@ # Installation | ||
| ### Additional Details | ||
| * Last updated: Fri, 02 Jul 2021 18:05:05 GMT | ||
| * Dependencies: [@types/vinyl](https://npmjs.com/package/@types/vinyl), [@types/glob-stream](https://npmjs.com/package/@types/glob-stream), [@types/node](https://npmjs.com/package/@types/node) | ||
| * Last updated: Fri, 20 Jan 2023 09:02:38 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) | ||
| * Global values: none | ||
@@ -15,0 +15,0 @@ |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-12.45%
9743
- Lines of code
- decreased by-31.02%
129
No dependency changes