16100116.4c8fcb98.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[4],{108:function(e,n,t){"use strict";t.d(n,"a",(function(){return p})),t.d(n,"b",(function(){return d}));var r=t(0),i=t.n(r);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function l(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function c(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?l(Object(t),!0).forEach((function(n){a(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):l(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function o(e,n){if(null==e)return{};var t,r,i=function(e,n){if(null==e)return{};var t,r,i={},a=Object.keys(e);for(r=0;r<a.length;r++)t=a[r],n.indexOf(t)>=0||(i[t]=e[t]);return i}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r<a.length;r++)t=a[r],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(i[t]=e[t])}return i}var s=i.a.createContext({}),b=function(e){var n=i.a.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):c(c({},n),e)),t},p=function(e){var n=b(e.components);return i.a.createElement(s.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return i.a.createElement(i.a.Fragment,{},n)}},y=i.a.forwardRef((function(e,n){var t=e.components,r=e.mdxType,a=e.originalType,l=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),p=b(t),y=r,d=p["".concat(l,".").concat(y)]||p[y]||u[y]||a;return t?i.a.createElement(d,c(c({ref:n},s),{},{components:t})):i.a.createElement(d,c({ref:n},s))}));function d(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var a=t.length,l=new Array(a);l[0]=y;var c={};for(var o in n)hasOwnProperty.call(n,o)&&(c[o]=n[o]);c.originalType=e,c.mdxType="string"==typeof e?e:r,l[1]=c;for(var s=2;s<a;s++)l[s]=t[s];return i.a.createElement.apply(null,l)}return i.a.createElement.apply(null,t)}y.displayName="MDXCreateElement"},66:function(e,n,t){"use strict";t.r(n),t.d(n,"frontMatter",(function(){return l})),t.d(n,"metadata",(function(){return c})),t.d(n,"toc",(function(){return o})),t.d(n,"default",(function(){return b}));var r=t(3),i=t(8),a=(t(0),t(108)),l={id:"vinyl-isvinyl",title:"Vinyl.isVinyl()",hide_title:!0,sidebar_label:"Vinyl.isVinyl()"},c={unversionedId:"api/vinyl-isvinyl",id:"api/vinyl-isvinyl",isDocsHomePage:!1,title:"Vinyl.isVinyl()",description:"Vinyl.isVinyl()",source:"@site/docs/api/vinyl-isvinyl.md",slug:"/api/vinyl-isvinyl",permalink:"/docs/en/api/vinyl-isvinyl",version:"current",sidebar_label:"Vinyl.isVinyl()",sidebar:"docs",previous:{title:"Vinyl",permalink:"/docs/en/api/vinyl"},next:{title:"Vinyl.isCustomProp()",permalink:"/docs/en/api/vinyl-iscustomprop"}},o=[{value:"Usage",id:"usage",children:[]},{value:"Signature",id:"signature",children:[{value:"Parameters",id:"parameters",children:[]},{value:"Returns",id:"returns",children:[]}]}],s={toc:o};function b(e){var n=e.components,t=Object(i.a)(e,["components"]);return Object(a.b)("wrapper",Object(r.a)({},s,t,{components:n,mdxType:"MDXLayout"}),Object(a.b)("h1",{id:"vinylisvinyl"},"Vinyl.isVinyl()"),Object(a.b)("p",null,"Determines if an object is a Vinyl instance. Use this method instead of ",Object(a.b)("inlineCode",{parentName:"p"},"instanceof"),"."),Object(a.b)("p",null,Object(a.b)("strong",{parentName:"p"},"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."),Object(a.b)("h2",{id:"usage"},"Usage"),Object(a.b)("pre",null,Object(a.b)("code",Object(r.a)({parentName:"pre"},{className:"language-js"}),"const Vinyl = require('vinyl');\n\nconst file = new Vinyl();\nconst notAFile = {};\n\nVinyl.isVinyl(file) === true;\nVinyl.isVinyl(notAFile) === false;\n")),Object(a.b)("h2",{id:"signature"},"Signature"),Object(a.b)("pre",null,Object(a.b)("code",Object(r.a)({parentName:"pre"},{className:"language-js"}),"Vinyl.isVinyl(file);\n")),Object(a.b)("h3",{id:"parameters"},"Parameters"),Object(a.b)("table",null,Object(a.b)("thead",{parentName:"table"},Object(a.b)("tr",{parentName:"thead"},Object(a.b)("th",Object(r.a)({parentName:"tr"},{align:"center"}),"parameter"),Object(a.b)("th",Object(r.a)({parentName:"tr"},{align:"center"}),"type"),Object(a.b)("th",Object(r.a)({parentName:"tr"},{align:null}),"note"))),Object(a.b)("tbody",{parentName:"table"},Object(a.b)("tr",{parentName:"tbody"},Object(a.b)("td",Object(r.a)({parentName:"tr"},{align:"center"}),"file"),Object(a.b)("td",Object(r.a)({parentName:"tr"},{align:"center"}),"object"),Object(a.b)("td",Object(r.a)({parentName:"tr"},{align:null}),"The object to check.")))),Object(a.b)("h3",{id:"returns"},"Returns"),Object(a.b)("p",null,"True if the ",Object(a.b)("inlineCode",{parentName:"p"},"file")," object is a Vinyl instance."))}b.isMDXComponent=!0}}]);