# @types/gulp-ttf2woff2

> TypeScript definitions for gulp-ttf2woff2

Latest version **4.0.5** (published 2024-08-23) · MIT license · 0 weekly downloads

## Install

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

## 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.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.5 |
| Published | 2024-08-23 |
| First published | 2021-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51446 |
| Maintainers | types |

## Links

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

## Dependencies (2)

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

## Recent versions

- 4.0.5 (latest) — 2024-08-23
- 4.0.4 (ts4.5) — 2023-11-07
- 4.0.1 (ts4.3) — 2023-05-10
- 4.0.0 (ts3.7) — 2021-11-16
- 4.0.3 — 2023-10-18
- 4.0.2 — 2023-09-20

## README

# Installation
> `npm install --save @types/gulp-ttf2woff2`

# Summary
This package contains type definitions for gulp-ttf2woff2 (https://github.com/nfroidure/gulp-ttf2woff2).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-ttf2woff2.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-ttf2woff2/index.d.ts)
````ts
/// <reference types="node"/>

import PluginError = require("plugin-error");

declare namespace ttf2woff2 {
    interface Options {
        /**
         * Also convert files that doesn't have the .ttf extension.
         */
        ignoreExt?: boolean;

        /**
         * Clone the file before converting him so that it will output the original file too.
         */
        clone?: boolean;
    }

    /**
     * Callback function handling the buffered content
     */
    type FileTransformCallback = <TResult, TError>(
        err: TError | null,
        buf: Buffer | undefined,
        cb: (err: PluginError<TError> | PluginError<Error> | null, buf: Buffer | undefined) => TResult,
    ) => TResult;

    /**
     * File level transform function (for use by other plugins)
     */
    function fileTransform(): FileTransformCallback;
}

/**
 * Create a WOFF2 font from a TTF font with Gulp
 *
 * @example
 * const ttf2woff2 = require('gulp-ttf2woff2');
 *
 * gulp.task('ttf2woff2', function(){
 *   gulp.src(['fonts/*.ttf'])
 *     .pipe(ttf2woff2())
 *     .pipe(gulp.dest('fonts/'));
 * });
 */
declare function ttf2woff2(options?: ttf2woff2.Options): NodeJS.ReadWriteStream;

export = ttf2woff2;

````

### Additional Details
 * Last updated: Fri, 23 Aug 2024 18:08:51 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [plugin-error](https://npmjs.com/package/plugin-error)

# Credits
These definitions were written by .

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