# @types/insert-module-globals

> TypeScript definitions for insert-module-globals

Latest version **7.0.6** (published 2025-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/insert-module-globals
pnpm add @types/insert-module-globals
yarn add @types/insert-module-globals
bun add @types/insert-module-globals
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 7.0.6 |
| Published | 2025-10-24 |
| First published | 2017-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51405 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/insert-module-globals
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/insert-module-globals
- npm.io page: https://npm.io/package/@types/insert-module-globals

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 7.0.6 (latest) — 2025-10-24
- 7.0.5 (ts5.1) — 2023-11-07
- 7.0.2 (ts3.7) — 2021-07-08
- 7.0.1 (ts2.8) — 2019-02-13
- 7.0.4 — 2023-10-18
- 7.0.3 — 2023-09-26
- 7.0.0 — 2017-06-01

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/insert-module-globals/index.d.ts)
````ts
/// <reference types="node" />

import stream = require("stream");

export = InsertModuleGlobals;

interface InsertModuleGlobals {
    /**
     * Return a transform stream inserter for the filename file that will accept a javascript file as input and
     * will output the file with a closure around the contents as necessary to define extra builtins.
     */
    (file: string, opts?: InsertModuleGlobals.Options): stream.Transform;

    /**
     * Defaults
     */
    readonly vars: {
        process(file: string): string;
        global(): string;
        "Buffer.isBuffer"(file: string): string;
        Buffer(): string;
        __filename(file: string, basedir: string): string;
        __dirname(file: string, basedir: string): string;
    };
}

declare const InsertModuleGlobals: InsertModuleGlobals;

declare namespace InsertModuleGlobals {
    interface Options {
        /**
         * When opts.always is true, wrap every file with all the global variables without parsing.
         * 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.
         * When opts.always is truthy but not true, avoid parsing but perform a quick test to determine if wrapping should be skipped.
         */
        always?: boolean | undefined;
        /**
         * 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.
         *
         * opts.vars properties with a . in their name will be executed instead of the parent object if ONLY that property is used.
         * For example, "Buffer.isBuffer" will mask "Buffer" only when there is a Buffer.isBuffer() call in a file and no other references to Buffer.
         */
        vars?: VarsOption | undefined;
        /**
         * If opts.debug is true, an inline source map will be generated to compensate for the extra lines.
         */
        debug?: boolean | undefined;
        basedir?: string | undefined;
    }

    interface VarsOption {
        [name: string]: InsertFunction | undefined;
    }

    type InsertFunction = (file: string, basedir: string) => VariableConfig | string;

    interface VariableConfig {
        id: string;
        source: string;
        suffix?: string | undefined;
    }
}

````

### Additional Details
 * Last updated: Fri, 24 Oct 2025 04:02:41 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Leonard Thieu](https://github.com/leonard-thieu).

---
_Source: https://npm.io/package/@types/insert-module-globals · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
