Installation

npm install --save @types/insert-module-globals

Summary

This package contains type definitions for insert-module-globals (https://github.com/browserify/insert-module-globals).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/insert-module-globals.

index.d.ts

1/// <reference types="node" />
2
3import * as stream from "stream";
4
5export = InsertModuleGlobals;
6
7interface InsertModuleGlobals {
8    /**
9     * Return a transform stream inserter for the filename file that will accept a javascript file as input and
10     * will output the file with a closure around the contents as necessary to define extra builtins.
11     */
12    (file: string, opts?: InsertModuleGlobals.Options): stream.Transform;
13
14    /**
15     * Defaults
16     */
17    readonly vars: {
18        process(file: string): string;
19        global(): string;
20        "Buffer.isBuffer"(file: string): string;
21        Buffer(): string;
22        __filename(file: string, basedir: string): string;
23        __dirname(file: string, basedir: string): string;
24    };
25}
26
27declare const InsertModuleGlobals: InsertModuleGlobals;
28
29declare namespace InsertModuleGlobals {
30    interface Options {
31        /**
32         * When opts.always is true, wrap every file with all the global variables without parsing.
33         * This is handy because parsing the scope can take a long time, so you can prioritize fast builds over saving bytes in the final output.
34         * When opts.always is truthy but not true, avoid parsing but perform a quick test to determine if wrapping should be skipped.
35         */
36        always?: boolean | undefined;
37        /**
38         * Use opts.vars to override the default inserted variables, or set opts.vars[name] to undefined to not insert a variable which would otherwise be inserted.
39         *
40         * opts.vars properties with a . in their name will be executed instead of the parent object if ONLY that property is used.
41         * For example, "Buffer.isBuffer" will mask "Buffer" only when there is a Buffer.isBuffer() call in a file and no other references to Buffer.
42         */
43        vars?: VarsOption | undefined;
44        /**
45         * If opts.debug is true, an inline source map will be generated to compensate for the extra lines.
46         */
47        debug?: boolean | undefined;
48        basedir?: string | undefined;
49    }
50
51    interface VarsOption {
52        [name: string]: InsertFunction | undefined;
53    }
54
55    type InsertFunction = (file: string, basedir: string) => VariableConfig | string;
56
57    interface VariableConfig {
58        id: string;
59        source: string;
60        suffix?: string | undefined;
61    }
62}
63

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: @types/node

Credits

These definitions were written by Leonard Thieu.