@types/gulp-size

  • Version 4.0.3
  • Published
  • 6.04 kB
  • 1 dependency
  • MIT license

Install

npm i @types/gulp-size
yarn add @types/gulp-size
pnpm add @types/gulp-size

Overview

TypeScript definitions for gulp-size

Index

Functions

function size

size: (options?: size.Options) => size.SizeStream;

    Interfaces

    interface Options

    interface Options {}

      property brotli

      brotli?: boolean | undefined;
      • Displays the brotli compressed size.

        false

      property gzip

      gzip?: boolean | undefined;
      • Displays the gzipped size.

        false

      property pretty

      pretty?: boolean | undefined;
      • Displays prettified size: 1337 B → 1.34 kB.

        true

      property showFiles

      showFiles?: boolean | undefined;
      • Displays the size of every file instead of just the total size.

        false

      property showTotal

      showTotal?: boolean | undefined;
      • Displays the total of all files.

        true

      property title

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

        ''

      property uncompressed

      uncompressed?: boolean | undefined;
      • Displays the uncompressed size.

        false

      interface SizeStream

      interface SizeStream extends NodeJS.ReadWriteStream {}

        property prettySize

        prettySize: string;
        • Prettified version of .size.

          Example 1

          14 kB

        property size

        size: number;
        • The total size of all files in bytes.

          Example 1

          12423000

        Package Files (1)

        Dependencies (1)

        Dev Dependencies (0)

        No dev dependencies.

        Peer Dependencies (0)

        No peer dependencies.

        Badge

        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/gulp-size.

        • Markdown
          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/gulp-size)
        • HTML
          <a href="https://www.jsdocs.io/package/@types/gulp-size"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>