vinyl/ 000755 001751 000177 0000000000 14607331423 013703 5 ustar 00runner 000000 000000 14607331423 14607331423 vinyl/LICENSE 000644 001751 000177 0000002165 14607331423 014714 0 ustar 00runner 000000 000000 14607331423 14607331423 MIT License
Copyright (c) Microsoft Corporation.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE
vinyl/README.md 000644 001751 000177 0000001140 14607331423 015160 0 ustar 00runner 000000 000000 14607331434 14607331423 # Installation
> `npm install --save @types/vinyl`
# Summary
This package contains type definitions for vinyl (https://github.com/gulpjs/vinyl).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/vinyl.
### Additional Details
* Last updated: Mon, 15 Apr 2024 23:06:59 GMT
* Dependencies: [@types/expect](https://npmjs.com/package/@types/expect), [@types/node](https://npmjs.com/package/@types/node)
# Credits
These definitions were written by [vvakame](https://github.com/vvakame), and [Georgii Dolzhykov](https://github.com/thorn0).
vinyl/index.d.ts 000644 001751 000177 0000024430 14607331423 015607 0 ustar 00runner 000000 000000 14607331423 14607331423 ///
import * as fs from "fs";
interface ConstructorOptions {
/**
* The current working directory of the file. Default: process.cwd()
*/
cwd?: string | undefined;
/**
* Used for relative pathing. Typically where a glob starts. Default: options.cwd
*/
base?: string | undefined;
/**
* Full path to the file.
*/
path?: string | undefined;
/**
* Stores the path history. If `options.path` and `options.history` are both passed,
* `options.path` is appended to `options.history`. All `options.history` paths are
* normalized by the `file.path` setter.
* Default: `[]` (or `[options.path]` if `options.path` is passed)
*/
history?: string[] | undefined;
/**
* The result of an fs.stat call. This is how you mark the file as a directory or
* symbolic link. See `isDirectory()`, `isSymbolic()` and `fs.Stats` for more information.
* https://nodejs.org/api/fs.html#fs_class_fs_stats
*/
stat?: fs.Stats | undefined;
/**
* File contents.
* Type: `Buffer`, `Stream`, or null
* Default: null
*/
contents?: Buffer | NodeJS.ReadableStream | null | undefined;
/**
* Any custom option properties will be directly assigned to the new Vinyl object.
*/
[customOption: string]: any;
}
interface FileConstructor {
new(options: ConstructorOptions & { contents: null }): File.NullFile;
new(options: ConstructorOptions & { contents: Buffer }): File.BufferFile;
new(
options: ConstructorOptions & { contents: NodeJS.ReadableStream },
): File.StreamFile;
new(options?: ConstructorOptions): File;
/**
* Checks if a given object is a vinyl file.
*/
isVinyl(obj: any): obj is File;
/**
* Checks if a property is not managed internally.
*/
isCustomProp(name: string): boolean;
prototype: File;
}
export = File;
declare let File: FileConstructor;
interface File {
/**
* Gets and sets the contents of the file. If set to a `Stream`, it is wrapped in
* a `cloneable-readable` stream.
*
* Throws when set to any value other than a `Stream`, a `Buffer` or `null`.
*/
contents: Buffer | NodeJS.ReadableStream | null;
/**
* Gets and sets current working directory. Will always be normalized and have trailing
* separators removed.
*
* Throws when set to any value other than non-empty strings.
*/
cwd: string;
//
/**
* Gets and sets base directory. Used for relative pathing (typically where a glob starts).
* When `null` or `undefined`, it simply proxies the `file.cwd` property. Will always be
* normalized and have trailing separators removed.
*
* Throws when set to any value other than non-empty strings or `null`/`undefined`.
*
* The setter's type is actually `string | null | undefined`, but TypeScript doesn't allow
* get/set accessors to be of different type. The property is declared as `string` for the
* compiler not to require useless null checks for the getter. (Hopefully, noone will need
* to assign `null` to this property.)
*/
base: string;
/**
* Gets and sets the absolute pathname string or `undefined`. Setting to a different value
* appends the new path to `file.history`. If set to the same value as the current path, it
* is ignored. All new values are normalized and have trailing separators removed.
*
* Throws when set to any value other than a string.
*
* The getter is actually of type `string | undefined` whereas the setter is just `string`,
* however TypeScript doesn't allow get/set accessors to be of different type. See the
* comment for the `base` properties.
*/
path: string;
/**
* Array of `file.path` values the Vinyl object has had, from `file.history[0]` (original)
* through `file.history[file.history.length - 1]` (current). `file.history` and its elements
* should normally be treated as read-only and only altered indirectly by setting `file.path`.
*/
readonly history: readonly string[];
/**
* Gets the result of `path.relative(file.base, file.path)`.
*
* Throws when set or when `file.path` is not set.
*
* Example:
*
* ```js
* var file = new File({
* cwd: '/',
* base: '/test/',
* path: '/test/file.js'
* });
*
* console.log(file.relative); // file.js
* ```
*/
relative: string;
/**
* Gets and sets the dirname of `file.path`. Will always be normalized and have trailing
* separators removed.
*
* Throws when `file.path` is not set.
*
* Example:
*
* ```js
* var file = new File({
* cwd: '/',
* base: '/test/',
* path: '/test/file.js'
* });
*
* console.log(file.dirname); // /test
*
* file.dirname = '/specs';
*
* console.log(file.dirname); // /specs
* console.log(file.path); // /specs/file.js
* ```
*/
dirname: string;
/**
* Gets and sets the basename of `file.path`.
*
* Throws when `file.path` is not set.
*
* Example:
*
* ```js
* var file = new File({
* cwd: '/',
* base: '/test/',
* path: '/test/file.js'
* });
*
* console.log(file.basename); // file.js
*
* file.basename = 'file.txt';
*
* console.log(file.basename); // file.txt
* console.log(file.path); // /test/file.txt
* ```
*/
basename: string;
/**
* Gets and sets stem (filename without suffix) of `file.path`.
*
* Throws when `file.path` is not set.
*
* Example:
*
* ```js
* var file = new File({
* cwd: '/',
* base: '/test/',
* path: '/test/file.js'
* });
*
* console.log(file.stem); // file
*
* file.stem = 'foo';
*
* console.log(file.stem); // foo
* console.log(file.path); // /test/foo.js
* ```
*/
stem: string;
/**
* Gets and sets extname of `file.path`.
*
* Throws when `file.path` is not set.
*
* Example:
*
* ```js
* var file = new File({
* cwd: '/',
* base: '/test/',
* path: '/test/file.js'
* });
*
* console.log(file.extname); // .js
*
* file.extname = '.txt';
*
* console.log(file.extname); // .txt
* console.log(file.path); // /test/file.txt
* ```
*/
extname: string;
/**
* Gets and sets the path where the file points to if it's a symbolic link. Will always
* be normalized and have trailing separators removed.
*
* Throws when set to any value other than a string.
*/
symlink: string | null;
stat: fs.Stats | null;
[customProperty: string]: any;
/**
* Returns `true` if the file contents are a `Buffer`, otherwise `false`.
*/
isBuffer(): this is File.BufferFile;
/**
* Returns `true` if the file contents are a `Stream`, otherwise `false`.
*/
isStream(): this is File.StreamFile;
/**
* Returns `true` if the file contents are `null`, otherwise `false`.
*/
isNull(): this is File.NullFile;
/**
* Returns `true` if the file represents a directory, otherwise `false`.
*
* A file is considered a directory when:
*
* - `file.isNull()` is `true`
* - `file.stat` is an object
* - `file.stat.isDirectory()` returns `true`
*
* When constructing a Vinyl object, pass in a valid `fs.Stats` object via `options.stat`.
* If you are mocking the `fs.Stats` object, you may need to stub the `isDirectory()` method.
*/
isDirectory(): this is File.DirectoryFile;
/**
* Returns `true` if the file represents a symbolic link, otherwise `false`.
*
* A file is considered symbolic when:
*
* - `file.isNull()` is `true`
* - `file.stat` is an object
* - `file.stat.isSymbolicLink()` returns `true`
*
* When constructing a Vinyl object, pass in a valid `fs.Stats` object via `options.stat`.
* If you are mocking the `fs.Stats` object, you may need to stub the `isSymbolicLink()` method.
*/
isSymbolic(): this is File.SymbolicFile;
/**
* Returns a new Vinyl object with all attributes cloned.
*
* __By default custom attributes are cloned deeply.__
*
* If `options` or `options.deep` is `false`, custom attributes will not be cloned deeply.
*
* If `file.contents` is a `Buffer` and `options.contents` is `false`, the `Buffer` reference
* will be reused instead of copied.
*/
clone(opts?: { contents?: boolean | undefined; deep?: boolean | undefined } | boolean): this;
/**
* Returns a formatted-string interpretation of the Vinyl object.
* Automatically called by node's `console.log`.
*/
inspect(): string;
/**
* @deprecated This method was removed in v2.0.
* If file.contents is a Buffer, it will write it to the stream.
* If file.contents is a Stream, it will pipe it to the stream.
* If file.contents is null, it will do nothing.
*/
pipe(
stream: T,
opts?: {
/**
* If false, the destination stream will not be ended (same as node core).
*/
end?: boolean | undefined;
},
): T;
}
declare namespace File {
// See https://github.com/Microsoft/TypeScript/issues/11796
interface BufferFile extends File {
contents: Buffer;
isStream(): this is never;
isNull(): this is never;
isDirectory(): this is never;
isSymbolic(): this is never;
}
interface StreamFile extends File {
contents: NodeJS.ReadableStream;
isBuffer(): this is never;
isNull(): this is never;
isDirectory(): this is never;
isSymbolic(): this is never;
}
interface NullFile extends File {
contents: null;
isStream(): this is never;
isBuffer(): this is never;
isDirectory(): this is DirectoryFile;
isSymbolic(): this is SymbolicFile;
}
interface DirectoryFile extends NullFile {
isSymbolic(): this is never;
}
interface SymbolicFile extends NullFile {
isDirectory(): this is never;
}
}
vinyl/package.json 000644 001751 000177 0000001735 14607331423 016201 0 ustar 00runner 000000 000000 14607331434 14607331423 {
"name": "@types/vinyl",
"version": "2.0.12",
"description": "TypeScript definitions for vinyl",
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/vinyl",
"license": "MIT",
"contributors": [
{
"name": "vvakame",
"githubUsername": "vvakame",
"url": "https://github.com/vvakame"
},
{
"name": "Georgii Dolzhykov",
"githubUsername": "thorn0",
"url": "https://github.com/thorn0"
}
],
"main": "",
"types": "index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
"directory": "types/vinyl"
},
"scripts": {},
"dependencies": {
"@types/expect": "^1.20.4",
"@types/node": "*"
},
"typesPublisherContentHash": "4d39b9b6291737b70ec3a41a7694f553a8d2e64884d13991c65b63b3e8375f65",
"typeScriptVersion": "4.7"
}