# @types/gulp-file-include

> TypeScript definitions for gulp-file-include

Latest version **0.14.8** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/gulp-file-include
pnpm add @types/gulp-file-include
yarn add @types/gulp-file-include
bun add @types/gulp-file-include
```

## Health

**Score 45/100 (D)** — status: abandoned.

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.14.8 |
| Published | 2023-11-07 |
| First published | 2016-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/gulp-file-include
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-file-include
- npm.io page: https://npm.io/package/@types/gulp-file-include

## Dependencies (1)

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

## Recent versions

- 0.14.8 (latest) — 2023-11-07
- 0.14.6 (ts4.3) — 2023-05-10
- 0.14.5 (ts3.6) — 2021-07-08
- 0.14.4 (ts3.0) — 2020-05-15
- 0.14.3 (ts2.0) — 2017-11-08
- 0.14.7 — 2023-10-18
- 0.14.2 — 2017-03-16
- 0.14.1 — 2016-09-25

## README

# Installation
> `npm install --save @types/gulp-file-include`

# Summary
This package contains type definitions for gulp-file-include (https://github.com/coderhaoxin/gulp-file-include).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-file-include.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-file-include/index.d.ts)
````ts
/// <reference types="node" />

declare function fileinclude(prefix: string): NodeJS.ReadWriteStream;
declare function fileinclude(opts: fileinclude.Options): NodeJS.ReadWriteStream;
declare namespace fileinclude {
    export interface Options {
        /** default: "@@" */
        prefix?: string | undefined;
        /** default: "" */
        suffix?: string | undefined;
        /**
         * Can be "@file" or "@root" or some base path.
         * default: "@file"
         */
        basepath?: "@file" | "@root" | string | undefined;
        /**
         * Filters basically look like functions that get passed into '@@include'.
         * When one of these functions is called, something of that name is looked
         * up in this object and called to get the contents of that include.
         */
        filters?: { [filter: string]: (arg: any) => string } | undefined;
        /**
         * Effectively a context for variables used in 'if' statements.
         */
        context?: { [contextVarName: string]: any } | undefined;
        /**
         * default: false
         */
        indent?: boolean | undefined;
    }
}

export = fileinclude;

````

### 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 [Daniel Rosenwasser](https://github.com/DanielRosenwasser).

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