# @types/gulp-size

> TypeScript definitions for gulp-size

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

## Install

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

## 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.3 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 4.0.3 (latest) — 2023-11-07
- 4.0.1 (ts4.3) — 2023-05-10
- 4.0.0 (ts4.2) — 2022-03-05
- 2.1.2 (ts3.8) — 2021-07-08
- 2.1.1 (ts2.3) — 2017-11-09
- 4.0.2 — 2023-10-18
- 2.1.0 — 2017-08-03
- 1.2.30 — 2017-03-16
- 1.2.29 — 2016-09-19
- 1.2.28 — 2016-07-14
- 1.2.27-alpha — 2016-07-08
- 1.2.26-alpha — 2016-07-04
- 1.2.25-alpha — 2016-07-02
- 1.2.24-alpha — 2016-07-01
- 1.2.23-alpha — 2016-07-01
- … 4 more at https://npm.io/package/@types/gulp-size/versions

## README

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

# Summary
This package contains type definitions for gulp-size (https://github.com/sindresorhus/gulp-size).

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

declare namespace size {
    interface Options {
        /**
         * Displays the size of every file instead of just the total size.
         *
         * @default false
         */
        showFiles?: boolean | undefined;

        /**
         * Displays the gzipped size.
         *
         * @default false
         */
        gzip?: boolean | undefined;

        /**
         * Give it a title so it's possible to distinguish the output of multiple instances logging at once.
         *
         * @default ''
         */
        title?: string | undefined;

        /**
         * Displays prettified size: 1337 B → 1.34 kB.
         *
         * @default true
         */
        pretty?: boolean | undefined;

        /**
         * Displays the total of all files.
         *
         * @default true
         */
        showTotal?: boolean | undefined;

        /**
         * Displays the brotli compressed size.
         *
         * @default false
         */
        brotli?: boolean | undefined;

        /**
         * Displays the uncompressed size.
         *
         * @default false
         */
        uncompressed?: boolean | undefined;
    }

    interface SizeStream extends NodeJS.ReadWriteStream {
        /**
         * The total size of all files in bytes.
         *
         * @example 12423000
         */
        size: number;

        /**
         * Prettified version of .size.
         *
         * @example 14 kB
         */
        prettySize: string;
    }
}

declare function size(options?: size.Options): size.SizeStream;

export = size;

````

### 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 [Tanguy Krotoff](https://github.com/tkrotoff), and [Remisery](https://github.com/remisery).

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