1 | # Installation
|
2 | > `npm install --save @types/gulp-load-plugins`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for gulp-load-plugins (https://github.com/jackfranklin/gulp-load-plugins).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-load-plugins.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-load-plugins/index.d.ts)
|
10 | ````ts
|
11 | // Type definitions for gulp-load-plugins
|
12 | // Project: https://github.com/jackfranklin/gulp-load-plugins
|
13 | // Definitions by: Joe Skeen <https://github.com/joeskeen>
|
14 | // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
15 |
|
16 | /// <reference types="node" />
|
17 |
|
18 | /** Loads in any gulp plugins and attaches them to an object, freeing you up from having to manually require each gulp plugin. */
|
19 | declare module 'gulp-load-plugins' {
|
20 |
|
21 | interface IOptions {
|
22 | /** the glob(s) to search for, default ['gulp-*', 'gulp.*'] */
|
23 | pattern?: string[] | undefined;
|
24 | /** where to find the plugins, searched up from process.cwd(), default 'package.json' */
|
25 | config?: string | undefined;
|
26 | /** which keys in the config to look within, default ['dependencies', 'devDependencies', 'peerDependencies'] */
|
27 | scope?: string[] | undefined;
|
28 | /** what to remove from the name of the module when adding it to the context, default /^gulp(-|\.)/ */
|
29 | replaceString?: RegExp | undefined;
|
30 | /** if true, transforms hyphenated plugin names to camel case, default true */
|
31 | camelize?: boolean | undefined;
|
32 | /** whether the plugins should be lazy loaded on demand, default true */
|
33 | lazy?: boolean | undefined;
|
34 | /** a mapping of plugins to rename, the key being the NPM name of the package, and the value being an alias you define */
|
35 | rename?: IPluginNameMappings | undefined;
|
36 | }
|
37 |
|
38 | interface IPluginNameMappings {
|
39 | [npmPackageName: string]: string
|
40 | }
|
41 |
|
42 | /** Loads in any gulp plugins and attaches them to an object, freeing you up from having to manually require each gulp plugin. */
|
43 | function gulpLoadPlugins<T extends IGulpPlugins>(options?: IOptions): T;
|
44 |
|
45 | namespace gulpLoadPlugins {}
|
46 |
|
47 | export = gulpLoadPlugins;
|
48 | }
|
49 |
|
50 | /**
|
51 | * Extend this interface to use Gulp plugins in your gulpfile.js
|
52 | */
|
53 | interface IGulpPlugins {
|
54 | }
|
55 |
|
56 | ````
|
57 |
|
58 | ### Additional Details
|
59 | * Last updated: Thu, 08 Jul 2021 14:22:30 GMT
|
60 | * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
|
61 | * Global values: none
|
62 |
|
63 | # Credits
|
64 | These definitions were written by [Joe Skeen](https://github.com/joeskeen).
|
65 |
|
\ | No newline at end of file |