Logo for jsDocs.io

@types/mute-stream

  • Version 0.0.4
  • Published
  • 4.5 kB
  • 1 dependency
  • MIT license

Install

npm i @types/mute-stream
yarn add @types/mute-stream
pnpm add @types/mute-stream

Overview

TypeScript definitions for mute-stream

Index

Classes

Interfaces

Classes

class MuteStream

class MuteStream extends Duplex {}

    constructor

    constructor(options?: MuteStream.Options);

      property isTTY

      isTTY: boolean;

        property mute

        mute: () => void;

          property unmute

          unmute: () => void;

            Interfaces

            interface Options

            interface Options {}

              property prompt

              prompt?: string | undefined;

              • If you are using a replacement char, and also using a prompt with a readline stream (as for a Password: ***** input), then specify what the prompt is so that backspace will work properly. Otherwise, pressing backspace will overwrite the prompt with the replacement character, which is weird.

              property replace

              replace?: string | undefined;

              • Set to a string to replace each character with the specified string when muted. (So you can show **** instead of the password, for example.)

              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/mute-stream.

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