@types/vinyl

What is @types/vinyl?

@types/vinyl provides TypeScript type definitions for the 'vinyl' package, which is a virtual file format used in the Node.js ecosystem, particularly in build systems like Gulp. It allows developers to handle file operations in memory, making it easier to manipulate files without writing them to disk.

What are @types/vinyl's main functionalities?

Creating a Vinyl File

This feature allows you to create a new Vinyl file object with specified properties such as current working directory (cwd), base path, file path, and contents.

const Vinyl = require('vinyl');
const file = new Vinyl({
  cwd: '/',
  base: '/test/',
  path: '/test/file.js',
  contents: Buffer.from('console.log("Hello, world!");')
});
console.log(file.path); // '/test/file.js'
console.log(file.contents.toString()); // 'console.log("Hello, world!");'

Checking File Properties

This feature allows you to check various properties of a Vinyl file object, such as whether its contents are a Buffer, a Stream, or null.

const Vinyl = require('vinyl');
const file = new Vinyl({
  path: '/test/file.js',
  contents: Buffer.from('console.log("Hello, world!");')
});
console.log(file.isBuffer()); // true
console.log(file.isStream()); // false
console.log(file.isNull()); // false

Cloning a Vinyl File

This feature allows you to create a clone of an existing Vinyl file object, duplicating its properties and contents.

const Vinyl = require('vinyl');
const file = new Vinyl({
  path: '/test/file.js',
  contents: Buffer.from('console.log("Hello, world!");')
});
const clonedFile = file.clone();
console.log(clonedFile.path); // '/test/file.js'
console.log(clonedFile.contents.toString()); // 'console.log("Hello, world!");'

Other packages similar to @types/vinyl

gulp

Gulp is a toolkit for automating painful or time-consuming tasks in your development workflow. It uses Vinyl as its file format, allowing you to create and manipulate files in memory. Compared to @types/vinyl, Gulp provides a higher-level API for defining tasks and managing file streams.

vinyl-fs

vinyl-fs is a file system adapter for Vinyl, providing methods to read, write, and watch files. It extends the functionality of Vinyl by integrating it with the file system, making it easier to work with files on disk. While @types/vinyl focuses on type definitions, vinyl-fs provides actual file system operations.

through2

through2 is a small wrapper around Node.js streams2 Transform to avoid explicit subclassing noise. It can be used to create transform streams that work with Vinyl files. While it doesn't provide type definitions for Vinyl, it is often used in conjunction with Vinyl in build systems like Gulp.

README

Installation

npm install --save @types/vinyl

Summary

This package contains type definitions for vinyl 1.1.0 (https://github.com/wearefractal/vinyl).

Details

Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/vinyl

Additional Details

• Last updated: Sun, 03 Jul 2016 23:17:32 GMT
• File structure: ProperModule
• Library Dependencies: node
• Module Dependencies: fs
• Global values: File

Credits

These definitions were written by vvakame https://github.com/vvakame/, jedmao https://github.com/jedmao.