UNPKG

@types/gulp-load-plugins

Version:
58 lines (46 loc) 2.36 kB
# Installation > `npm install --save @types/gulp-load-plugins` # Summary This package contains type definitions for gulp-load-plugins (https://github.com/jackfranklin/gulp-load-plugins). # Details Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-load-plugins. ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-load-plugins/index.d.ts) ````ts /// <reference types="node" /> /** Loads in any gulp plugins and attaches them to an object, freeing you up from having to manually require each gulp plugin. */ declare module "gulp-load-plugins" { interface IOptions { /** the glob(s) to search for, default ['gulp-*', 'gulp.*'] */ pattern?: string[] | undefined; /** where to find the plugins, searched up from process.cwd(), default 'package.json' */ config?: string | undefined; /** which keys in the config to look within, default ['dependencies', 'devDependencies', 'peerDependencies'] */ scope?: string[] | undefined; /** what to remove from the name of the module when adding it to the context, default /^gulp(-|\.)/ */ replaceString?: RegExp | undefined; /** if true, transforms hyphenated plugin names to camel case, default true */ camelize?: boolean | undefined; /** whether the plugins should be lazy loaded on demand, default true */ lazy?: boolean | undefined; /** a mapping of plugins to rename, the key being the NPM name of the package, and the value being an alias you define */ rename?: IPluginNameMappings | undefined; } interface IPluginNameMappings { [npmPackageName: string]: string; } /** Loads in any gulp plugins and attaches them to an object, freeing you up from having to manually require each gulp plugin. */ function gulpLoadPlugins<T extends IGulpPlugins>(options?: IOptions): T; namespace gulpLoadPlugins {} export = gulpLoadPlugins; } /** * Extend this interface to use Gulp plugins in your gulpfile.js */ interface IGulpPlugins { } ```` ### Additional Details * Last updated: Tue, 07 Nov 2023 03:09:37 GMT * Dependencies: [@types/node](https://npmjs.com/package/@types/node) # Credits These definitions were written by [Joe Skeen](https://github.com/joeskeen).