Type alias SharedOptions

SharedOptions: {
    async?: boolean;
    encoding?: BufferEncoding | null | "buffer";
    objectMode?: boolean;
    signal?: AbortSignal;
}

Options passed to the Minipass constructor.

Optional async?: boolean

Defer all data emission and other events until the end of the current tick, similar to Node core streams
Optional encoding?: BufferEncoding | null | "buffer"

Output string encoding. Set to null or 'buffer' (or omit) to emit Buffer objects rather than strings.

Conflicts with objectMode
Optional objectMode?: boolean

Output data exactly as it was written, supporting non-buffer/string data (such as arbitrary objects, falsey values, etc.)

Conflicts with encoding
Optional signal?: AbortSignal

A signal which will abort the stream