blob: b2d8ce6694b4ecec705a0e2ae0e47026b83c9091 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/* (c) 2015 Ari Porad (@ariporad) <http://ariporad.com>. License: ariporad.mit-license.org */
/**
* The hook. Accepts the code of the module and the filename.
*/
declare type Hook = (code: string, filename: string) => string;
/**
* A matcher function, will be called with path to a file.
*
* Should return truthy if the file should be hooked, falsy otherwise.
*/
declare type Matcher = (path: string) => boolean;
/**
* Reverts the hook when called.
*/
declare type RevertFunction = () => void;
interface Options {
/**
* The extensions to hook. Should start with '.' (ex. ['.js']).
*
* Takes precedence over `exts`, `extension` and `ext`.
*
* @alias exts
* @alias extension
* @alias ext
* @default ['.js']
*/
extensions?: ReadonlyArray<string> | string;
/**
* The extensions to hook. Should start with '.' (ex. ['.js']).
*
* Takes precedence over `extension` and `ext`.
*
* @alias extension
* @alias ext
* @default ['.js']
*/
exts?: ReadonlyArray<string> | string;
/**
* The extensions to hook. Should start with '.' (ex. ['.js']).
*
* Takes precedence over `ext`.
*
* @alias ext
* @default ['.js']
*/
extension?: ReadonlyArray<string> | string;
/**
* The extensions to hook. Should start with '.' (ex. ['.js']).
*
* @default ['.js']
*/
ext?: ReadonlyArray<string> | string;
/**
* A matcher function, will be called with path to a file.
*
* Should return truthy if the file should be hooked, falsy otherwise.
*/
matcher?: Matcher | null;
/**
* Auto-ignore node_modules. Independent of any matcher.
*
* @default true
*/
ignoreNodeModules?: boolean;
}
/**
* Add a require hook.
*
* @param hook The hook. Accepts the code of the module and the filename. Required.
* @returns The `revert` function. Reverts the hook when called.
*/
export declare function addHook(hook: Hook, opts?: Options): RevertFunction;
export {};
|
