Installation
npm install --save @types/mute-stream
Summary
This package contains type definitions for mute-stream (https://github.com/isaacs/mute-stream#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mute-stream.
index.d.ts
/// <reference types="node" />
import { Duplex } from "stream";
declare namespace MuteStream {
interface Options {
/**
* Set to a string to replace each character with the specified string when muted.
* (So you can show **** instead of the password, for example.)
*/
replace?: 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.
*/
prompt?: string | undefined;
}
}
declare class MuteStream extends Duplex {
constructor(options?: MuteStream.Options);
mute: () => void;
unmute: () => void;
isTTY: boolean;
}
export = MuteStream;
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:39 GMT
- Dependencies: @types/node
Credits
These definitions were written by Adam Jarret.