Class WriteStream

Hierarchy

  • Writable
    • WriteStream

Implements

  • WriteStream

Constructors

constructor

Properties

_readableState _writableState [asyncDispose] bytesWritten closed destroyed errored path pending readable readableFlowing readableHighWaterMark readableLength writable writableCorked writableEnded writableFinished writableHighWaterMark writableLength writableNeedDrain writableObjectMode

Methods

_destroy _final _read _undestroy _write _writev? [asyncIterator] addListener asIndexedPairs close compose cork destroy drop emit end eventNames every filter find flatMap forEach getMaxListeners isPaused iterator listenerCount listeners map off on once pause pipe prependListener prependOnceListener push rawListeners read reduce removeAllListeners removeListener resume setDefaultEncoding setEncoding setMaxListeners some take toArray uncork unpipe unshift wrap write

Constructors

constructor

  • new WriteStream(opts?: WritableOptions): WriteStream

  • Parameters

    • Optionalopts: WritableOptions

    Returns WriteStream

Properties

_readableState

_readableState: ReadableState

_writableState

_writableState: WritableState

[asyncDispose]

"[asyncDispose]": never

bytesWritten

bytesWritten: number

The number of bytes written so far. Does not include data that is still queued for writing.

Since

v0.4.7

Readonlyclosed

closed: boolean

destroyed

destroyed: boolean

Readonlyerrored

errored: null | Error

path

path: string | Buffer<ArrayBufferLike>

The path to the file the stream is writing to as specified in the first argument to createWriteStream. If path is passed as a string, thenwriteStream.path will be a string. If path is passed as a Buffer, thenwriteStream.path will be a Buffer.

Since

v0.1.93

pending

pending: boolean

This property is true if the underlying file has not been opened yet, i.e. before the 'ready' event is emitted.

Since

v11.2.0

readable

readable: boolean

ReadonlyreadableFlowing

readableFlowing: null | boolean

ReadonlyreadableHighWaterMark

readableHighWaterMark: number

ReadonlyreadableLength

readableLength: number

writable

writable: boolean

ReadonlywritableCorked

writableCorked: never

ReadonlywritableEnded

writableEnded: never

ReadonlywritableFinished

writableFinished: never

ReadonlywritableHighWaterMark

writableHighWaterMark: number

ReadonlywritableLength

writableLength: number

ReadonlywritableNeedDrain

writableNeedDrain: boolean

ReadonlywritableObjectMode

writableObjectMode: never

Methods

_destroy

  • _destroy(error: null | Error, callback: (error: null | Error) => void): void

  • Parameters

    • error: null | Error
    • callback: (error: null | Error) => void

    Returns void

_final

  • _final(callback: (error?: null | Error) => void): void

  • Parameters

    • callback: (error?: null | Error) => void

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_undestroy

  • _undestroy(): void

  • Returns void

_write

  • _write(
        chunk: any,
        encoding: string,
        callback: (error?: null | Error) => void,
    ): void

  • Parameters

    • chunk: any
    • encoding: string
    • callback: (error?: null | Error) => void

    Returns void

Optional_writev

  • _writev(
        chunks: { chunk: any; encoding: string }[],
        callback: (error?: null | Error) => void,
    ): void

  • Parameters

    • chunks: { chunk: any; encoding: string }[]
    • callback: (error?: null | Error) => void

    Returns void

[asyncIterator]

  • "[asyncIterator]"(): AsyncIterableIterator<any, any, any>

  • Returns AsyncIterableIterator<any, any, any>

addListener

  • addListener(event: "close", listener: () => void): this

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: "close"
    • listener: () => void

    Returns this

  • addListener(event: "drain", listener: () => void): this

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: "drain"
    • listener: () => void

    Returns this

  • addListener(event: "error", listener: (err: Error) => void): this

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: "error"
    • listener: (err: Error) => void

    Returns this

  • addListener(event: "finish", listener: () => void): this

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: "finish"
    • listener: () => void

    Returns this

  • addListener(event: "pipe", listener: (src: Readable) => void): this

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: "pipe"
    • listener: (src: Readable) => void

    Returns this

  • addListener(event: "unpipe", listener: (src: Readable) => void): this

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void

    Returns this

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void

    Returns this

asIndexedPairs

  • asIndexedPairs(options?: SignalOption): Readable

  • Parameters

    • Optionaloptions: SignalOption

    Returns Readable

close

  • close(callback?: Callback<[void], null>): void

  • Closes writeStream. Optionally accepts a callback that will be executed once the writeStreamis closed.

    Parameters

    Returns void

    Since

    v0.9.4

compose

  • compose<T extends ReadableStream>(
        stream:
            | ComposeFnParam
            | T
            | Iterable<T, any, any>
            | AsyncIterable<T, any, any>,
        options?: { signal: AbortSignal },
    ): T

  • Type Parameters

    • T extends ReadableStream

    Parameters

    • stream: ComposeFnParam | T | Iterable<T, any, any> | AsyncIterable<T, any, any>
    • Optionaloptions: { signal: AbortSignal }

    Returns T

cork

  • cork(): void

  • Returns void

destroy

  • destroy(error?: Error): this

  • Parameters

    • Optionalerror: Error

    Returns this

drop

  • drop(limit: number, options?: SignalOption): Readable

  • Parameters

    • limit: number
    • Optionaloptions: SignalOption

    Returns Readable

emit

  • emit(event: "close"): boolean

  • Parameters

    • event: "close"

    Returns boolean

  • emit(event: "drain"): boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • emit(event: "error", err: Error): boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • emit(event: "finish"): boolean

  • Parameters

    • event: "finish"

    Returns boolean

  • emit(event: "pipe", src: Readable): boolean

  • Parameters

    • event: "pipe"
    • src: Readable

    Returns boolean

  • emit(event: "unpipe", src: Readable): boolean

  • Parameters

    • event: "unpipe"
    • src: Readable

    Returns boolean

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • ...args: any[]

    Returns boolean

end

  • end(cb?: () => void): this

  • Parameters

    • Optionalcb: () => void

    Returns this

  • end(chunk: any, cb?: () => void): this

  • Parameters

    • chunk: any
    • Optionalcb: () => void

    Returns this

  • end(chunk: any, encoding?: string, cb?: () => void): this

  • Parameters

    • chunk: any
    • Optionalencoding: string
    • Optionalcb: () => void

    Returns this

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

every

  • every(
        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
        options?: ArrayOptions,
    ): Promise<boolean>

  • Parameters

    • fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>
    • Optionaloptions: ArrayOptions

    Returns Promise<boolean>

filter

  • filter(
        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
        options?: ArrayOptions,
    ): Readable

  • Parameters

    • fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>
    • Optionaloptions: ArrayOptions

    Returns Readable

find

  • find<T>(
        fn: (data: any, options?: SignalOption) => data is T,
        options?: ArrayOptions,
    ): Promise<undefined | T>

  • Type Parameters

    • T

    Parameters

    • fn: (data: any, options?: SignalOption) => data is T
    • Optionaloptions: ArrayOptions

    Returns Promise<undefined | T>

  • find(
        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
        options?: ArrayOptions,
    ): Promise<any>

  • Parameters

    • fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>
    • Optionaloptions: ArrayOptions

    Returns Promise<any>

flatMap

  • flatMap(
        fn: (data: any, options?: SignalOption) => any,
        options?: ArrayOptions,
    ): Readable

  • Parameters

    • fn: (data: any, options?: SignalOption) => any
    • Optionaloptions: ArrayOptions

    Returns Readable

forEach

  • forEach(
        fn: (data: any, options?: SignalOption) => void | Promise<void>,
        options?: ArrayOptions,
    ): Promise<void>

  • Parameters

    • fn: (data: any, options?: SignalOption) => void | Promise<void>
    • Optionaloptions: ArrayOptions

    Returns Promise<void>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

isPaused

  • isPaused(): boolean

  • Returns boolean

iterator

  • iterator(
        options?: { destroyOnReturn?: boolean },
    ): AsyncIterableIterator<any, any, any>

  • Parameters

    • Optionaloptions: { destroyOnReturn?: boolean }

    Returns AsyncIterableIterator<any, any, any>

listenerCount

  • listenerCount(eventName: string | symbol): number

  • Parameters

    • eventName: string | symbol

    Returns number

listeners

  • listeners(eventName: string | symbol): Function[]

  • Parameters

    • eventName: string | symbol

    Returns Function[]

map

  • map(
        fn: (data: any, options?: SignalOption) => any,
        options?: ArrayOptions,
    ): Readable

  • Parameters

    • fn: (data: any, options?: SignalOption) => any
    • Optionaloptions: ArrayOptions

    Returns Readable

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void

    Returns this

on

  • on(event: "close", listener: () => void): this

  • Parameters

    • event: "close"
    • listener: () => void

    Returns this

  • on(event: "drain", listener: () => void): this

  • Parameters

    • event: "drain"
    • listener: () => void

    Returns this

  • on(event: "error", listener: (err: Error) => void): this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

    Returns this

  • on(event: "finish", listener: () => void): this

  • Parameters

    • event: "finish"
    • listener: () => void

    Returns this

  • on(event: "pipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void

    Returns this

  • on(event: "unpipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void

    Returns this

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void

    Returns this

once

  • once(event: "close", listener: () => void): this

  • Parameters

    • event: "close"
    • listener: () => void

    Returns this

  • once(event: "drain", listener: () => void): this

  • Parameters

    • event: "drain"
    • listener: () => void

    Returns this

  • once(event: "error", listener: (err: Error) => void): this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

    Returns this

  • once(event: "finish", listener: () => void): this

  • Parameters

    • event: "finish"
    • listener: () => void

    Returns this

  • once(event: "pipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void

    Returns this

  • once(event: "unpipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void

    Returns this

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void

    Returns this

pause

  • pause(): this

  • Returns this

pipe

  • pipe<T extends _IWritable>(destination: T, options?: { end?: boolean }): T

  • Type Parameters

    • T extends _IWritable

    Parameters

    • destination: T
    • Optionaloptions: { end?: boolean }

    Returns T

prependListener

  • prependListener(event: "close", listener: () => void): this

  • Parameters

    • event: "close"
    • listener: () => void

    Returns this

  • prependListener(event: "drain", listener: () => void): this

  • Parameters

    • event: "drain"
    • listener: () => void

    Returns this

  • prependListener(event: "error", listener: (err: Error) => void): this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

    Returns this

  • prependListener(event: "finish", listener: () => void): this

  • Parameters

    • event: "finish"
    • listener: () => void

    Returns this

  • prependListener(event: "pipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void

    Returns this

  • prependListener(event: "unpipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void

    Returns this

  • prependListener(
        event: string | symbol,
        listener: (...args: any[]) => void,
    ): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void

    Returns this

prependOnceListener

  • prependOnceListener(event: "close", listener: () => void): this

  • Parameters

    • event: "close"
    • listener: () => void

    Returns this

  • prependOnceListener(event: "drain", listener: () => void): this

  • Parameters

    • event: "drain"
    • listener: () => void

    Returns this

  • prependOnceListener(event: "error", listener: (err: Error) => void): this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

    Returns this

  • prependOnceListener(event: "finish", listener: () => void): this

  • Parameters

    • event: "finish"
    • listener: () => void

    Returns this

  • prependOnceListener(event: "pipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void

    Returns this

  • prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void

    Returns this

  • prependOnceListener(
        event: string | symbol,
        listener: (...args: any[]) => void,
    ): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void

    Returns this

push

  • push(chunk: any, encoding?: string): boolean

  • Parameters

    • chunk: any
    • Optionalencoding: string

    Returns boolean

rawListeners

  • rawListeners(eventName: string | symbol): Function[]

  • Parameters

    • eventName: string | symbol

    Returns Function[]

read

  • read(size?: number): any

  • Parameters

    • Optionalsize: number

    Returns any

reduce

  • reduce<T = any>(
        fn: (
            previous: any,
            data: any,
            options?: Pick<ArrayOptions, "signal">,
        ) => T,
        initial?: undefined,
        options?: Pick<ArrayOptions, "signal">,
    ): Promise<T>

  • Type Parameters

    • T = any

    Parameters

    • fn: (previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T
    • Optionalinitial: undefined
    • Optionaloptions: Pick<ArrayOptions, "signal">

    Returns Promise<T>

  • reduce<T = any>(
        fn: (
            previous: T,
            data: any,
            options?: Pick<ArrayOptions, "signal">,
        ) => T,
        initial: T,
        options?: Pick<ArrayOptions, "signal">,
    ): Promise<T>

  • Type Parameters

    • T = any

    Parameters

    • fn: (previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T
    • initial: T
    • Optionaloptions: Pick<ArrayOptions, "signal">

    Returns Promise<T>

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optionalevent: string | symbol

    Returns this

removeListener

  • removeListener(event: "close", listener: () => void): this

  • Parameters

    • event: "close"
    • listener: () => void

    Returns this

  • removeListener(event: "drain", listener: () => void): this

  • Parameters

    • event: "drain"
    • listener: () => void

    Returns this

  • removeListener(event: "error", listener: (err: Error) => void): this

  • Parameters

    • event: "error"
    • listener: (err: Error) => void

    Returns this

  • removeListener(event: "finish", listener: () => void): this

  • Parameters

    • event: "finish"
    • listener: () => void

    Returns this

  • removeListener(event: "pipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "pipe"
    • listener: (src: Readable) => void

    Returns this

  • removeListener(event: "unpipe", listener: (src: Readable) => void): this

  • Parameters

    • event: "unpipe"
    • listener: (src: Readable) => void

    Returns this

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void

    Returns this

resume

  • resume(): this

  • Returns this

setDefaultEncoding

  • setDefaultEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setEncoding

  • setEncoding(encoding: string): this

  • Parameters

    • encoding: string

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

some

  • some(
        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
        options?: ArrayOptions,
    ): Promise<boolean>

  • Parameters

    • fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>
    • Optionaloptions: ArrayOptions

    Returns Promise<boolean>

take

  • take(limit: number, options?: SignalOption): Readable

  • Parameters

    • limit: number
    • Optionaloptions: SignalOption

    Returns Readable

toArray

  • toArray(options?: SignalOption): Promise<any[]>

  • Parameters

    • Optionaloptions: SignalOption

    Returns Promise<any[]>

uncork

  • uncork(): void

  • Returns void

unpipe

  • unpipe(destination?: Writable): this

  • Parameters

    • Optionaldestination: Writable

    Returns this

unshift

  • unshift(chunk: any): void

  • Parameters

    • chunk: any

    Returns void

wrap

  • wrap(oldStream: Readable): this

  • Parameters

    • oldStream: Readable

    Returns this

write

  • write(chunk: any, cb?: (error: undefined | null | Error) => void): boolean

  • Parameters

    • chunk: any
    • Optionalcb: (error: undefined | null | Error) => void

    Returns boolean

  • write(
        chunk: any,
        encoding?: string,
        cb?: (error: undefined | null | Error) => void,
    ): boolean

  • Parameters

    • chunk: any
    • Optionalencoding: string
    • Optionalcb: (error: undefined | null | Error) => void

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods