-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Add Vinyl.isVinyl() documentation
- Loading branch information
1 parent
fc09067
commit 25a22bf
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
<!-- front-matter | ||
id: api-vinyl-isvinyl | ||
title: Vinyl.isVinyl() | ||
hide_title: true | ||
sidebar_label: Vinyl.isVinyl() | ||
--> | ||
|
||
# Vinyl.isVinyl() | ||
|
||
Determines if an object is a Vinyl instance. Use this method instead of `instanceof`. | ||
|
||
**Note**: This method uses an internal property that some older versions of Vinyl didn't expose resulting in a false negative if using an outdated version. | ||
|
||
## Usage | ||
|
||
```js | ||
const Vinyl = require('vinyl'); | ||
|
||
const file = new Vinyl(); | ||
const notAFile = {}; | ||
|
||
Vinyl.isVinyl(file) === true; | ||
Vinyl.isVinyl(notAFile) === false; | ||
``` | ||
|
||
## Signature | ||
|
||
```js | ||
Vinyl.isVinyl(file); | ||
``` | ||
|
||
### Parameters | ||
|
||
| parameter | type | note | | ||
|:--------------:|:------:|-------| | ||
| file | object | The object to check. | | ||
|
||
### Returns | ||
|
||
True if the `file` object is a Vinyl instance. | ||
|