fs.writestream

@listenai/lisa_core / Exports / fs / WriteStream

Class: WriteStream

fs.WriteStream

Hierarchy

• Writable

  ↳ WriteStream

Table of contents

Constructors

• constructor

Properties

• bytesWritten
• destroyed
• path
• pending
• writable
• writableCorked
• writableEnded
• writableFinished
• writableHighWaterMark
• writableLength
• writableObjectMode
• captureRejectionSymbol
• captureRejections
• defaultMaxListeners
• errorMonitor

Methods

• _destroy
• _final
• _write
• _writev
• addListener
• close
• cork
• destroy
• emit
• end
• eventNames
• getMaxListeners
• listenerCount
• listeners
• off
• on
• once
• pipe
• prependListener
• prependOnceListener
• rawListeners
• removeAllListeners
• removeListener
• setDefaultEncoding
• setMaxListeners
• uncork
• write
• listenerCount
• on
• once

Constructors

constructor

• new WriteStream(opts?)

Parameters

Name	Type
opts?	WritableOptions

Inherited from

stream.Writable.constructor

Defined in

node_modules/@types/node/stream.d.ts:153

Properties

bytesWritten

• bytesWritten: number

Defined in

node_modules/@types/node/fs.d.ts:219

---

destroyed

• destroyed: boolean

Inherited from

stream.Writable.destroyed

Defined in

node_modules/@types/node/stream.d.ts:153

---

path

• path: string | Buffer

Defined in

node_modules/@types/node/fs.d.ts:220

---

pending

• pending: boolean

Defined in

node_modules/@types/node/fs.d.ts:221

---

writable

• Readonly writable: boolean

Inherited from

stream.Writable.writable

Defined in

node_modules/@types/node/stream.d.ts:146

---

writableCorked

• Readonly writableCorked: number

Inherited from

stream.Writable.writableCorked

Defined in

node_modules/@types/node/stream.d.ts:152

---

writableEnded

• Readonly writableEnded: boolean

Inherited from

stream.Writable.writableEnded

Defined in

node_modules/@types/node/stream.d.ts:147

---

writableFinished

• Readonly writableFinished: boolean

Inherited from

stream.Writable.writableFinished

Defined in

node_modules/@types/node/stream.d.ts:148

---

writableHighWaterMark

• Readonly writableHighWaterMark: number

Inherited from

stream.Writable.writableHighWaterMark

Defined in

node_modules/@types/node/stream.d.ts:149

---

writableLength

• Readonly writableLength: number

Inherited from

stream.Writable.writableLength

Defined in

node_modules/@types/node/stream.d.ts:150

---

writableObjectMode

• Readonly writableObjectMode: boolean

Inherited from

stream.Writable.writableObjectMode

Defined in

node_modules/@types/node/stream.d.ts:151

---

captureRejectionSymbol

▪ Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

stream.Writable.captureRejectionSymbol

Defined in

node_modules/@types/node/events.d.ts:43

---

captureRejections

▪ Static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

stream.Writable.captureRejections

Defined in

node_modules/@types/node/events.d.ts:49

---

defaultMaxListeners

▪ Static defaultMaxListeners: number

Inherited from

stream.Writable.defaultMaxListeners

Defined in

node_modules/@types/node/events.d.ts:50

---

errorMonitor

▪ Static Readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Inherited from

stream.Writable.errorMonitor

Defined in

node_modules/@types/node/events.d.ts:42

Methods

_destroy

▸ _destroy(error, callback): void

Parameters

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

Returns

void

Inherited from

stream.Writable._destroy

Defined in

node_modules/@types/node/stream.d.ts:157

---

_final

▸ _final(callback): void

Parameters

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

Returns

void

Inherited from

stream.Writable._final

Defined in

node_modules/@types/node/stream.d.ts:158

---

_write

▸ _write(chunk, encoding, callback): void

Parameters

Name	Type
chunk	any
encoding	BufferEncoding
callback	(error?: null | Error) => void

Returns

void

Inherited from

stream.Writable._write

Defined in

node_modules/@types/node/stream.d.ts:155

---

_writev

▸ Optional _writev(chunks, callback): void

Parameters

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

Returns

void

Inherited from

stream.Writable._writev

Defined in

node_modules/@types/node/stream.d.ts:156

---

addListener

▸ addListener(event, listener): WriteStream

events.EventEmitter

1. open
2. close
3. ready

Parameters

Name	Type
event	"close"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:229

▸ addListener(event, listener): WriteStream

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:230

▸ addListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:231

▸ addListener(event, listener): WriteStream

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:232

▸ addListener(event, listener): WriteStream

Parameters

Name	Type
event	"open"
listener	(fd: number) => void

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:233

▸ addListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:234

▸ addListener(event, listener): WriteStream

Parameters

Name	Type
event	"ready"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:235

▸ addListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:236

▸ addListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.addListener

Defined in

node_modules/@types/node/fs.d.ts:237

---

close

▸ close(): void

Returns

void

Defined in

node_modules/@types/node/fs.d.ts:218

---

cork

▸ cork(): void

Returns

void

Inherited from

stream.Writable.cork

Defined in

node_modules/@types/node/stream.d.ts:165

---

destroy

▸ destroy(error?): void

Parameters

Name	Type
error?	Error

Returns

void

Inherited from

stream.Writable.destroy

Defined in

node_modules/@types/node/stream.d.ts:167

---

emit

▸ emit(event): boolean

Parameters

Name	Type
event	"close"

Returns

boolean

Inherited from

stream.Writable.emit

Defined in

node_modules/@types/node/stream.d.ts:187

▸ emit(event): boolean

Parameters

Name	Type
event	"drain"

Returns

boolean

Inherited from

stream.Writable.emit

Defined in

node_modules/@types/node/stream.d.ts:188

▸ emit(event, err): boolean

Parameters

Name	Type
event	"error"
err	Error

Returns

boolean

Inherited from

stream.Writable.emit

Defined in

node_modules/@types/node/stream.d.ts:189

▸ emit(event): boolean

Parameters

Name	Type
event	"finish"

Returns

boolean

Inherited from

stream.Writable.emit

Defined in

node_modules/@types/node/stream.d.ts:190

▸ emit(event, src): boolean

Parameters

Name	Type
event	"pipe"
src	Readable

Returns

boolean

Inherited from

stream.Writable.emit

Defined in

node_modules/@types/node/stream.d.ts:191

▸ emit(event, src): boolean

Parameters

Name	Type
event	"unpipe"
src	Readable

Returns

boolean

Inherited from

stream.Writable.emit

Defined in

node_modules/@types/node/stream.d.ts:192

▸ emit(event, ...args): boolean

Parameters

Name	Type
event	string | symbol
...args	any[]

Returns

boolean

Inherited from

stream.Writable.emit

Defined in

node_modules/@types/node/stream.d.ts:193

---

end

▸ end(cb?): void

Parameters

Name	Type
cb?	() => void

Returns

void

Inherited from

stream.Writable.end

Defined in

node_modules/@types/node/stream.d.ts:162

▸ end(chunk, cb?): void

Parameters

Name	Type
chunk	any
cb?	() => void

Returns

void

Inherited from

stream.Writable.end

Defined in

node_modules/@types/node/stream.d.ts:163

▸ end(chunk, encoding, cb?): void

Parameters

Name	Type
chunk	any
encoding	BufferEncoding
cb?	() => void

Returns

void

Inherited from

stream.Writable.end

Defined in

node_modules/@types/node/stream.d.ts:164

---

eventNames

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

Returns

(string | symbol)[]

Inherited from

stream.Writable.eventNames

Defined in

node_modules/@types/node/events.d.ts:77

---

getMaxListeners

▸ getMaxListeners(): number

Returns

number

Inherited from

stream.Writable.getMaxListeners

Defined in

node_modules/@types/node/events.d.ts:69

---

listenerCount

▸ listenerCount(event): number

Parameters

Name	Type
event	string | symbol

Returns

number

Inherited from

stream.Writable.listenerCount

Defined in

node_modules/@types/node/events.d.ts:73

---

listeners

▸ listeners(event): Function[]

Parameters

Name	Type
event	string | symbol

Returns

Function[]

Inherited from

stream.Writable.listeners

Defined in

node_modules/@types/node/events.d.ts:70

---

off

▸ off(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Inherited from

stream.Writable.off

Defined in

node_modules/@types/node/events.d.ts:66

---

on

▸ on(event, listener): WriteStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:239

▸ on(event, listener): WriteStream

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:240

▸ on(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:241

▸ on(event, listener): WriteStream

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:242

▸ on(event, listener): WriteStream

Parameters

Name	Type
event	"open"
listener	(fd: number) => void

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:243

▸ on(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:244

▸ on(event, listener): WriteStream

Parameters

Name	Type
event	"ready"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:245

▸ on(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:246

▸ on(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.on

Defined in

node_modules/@types/node/fs.d.ts:247

---

once

▸ once(event, listener): WriteStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:249

▸ once(event, listener): WriteStream

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:250

▸ once(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:251

▸ once(event, listener): WriteStream

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:252

▸ once(event, listener): WriteStream

Parameters

Name	Type
event	"open"
listener	(fd: number) => void

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:253

▸ once(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:254

▸ once(event, listener): WriteStream

Parameters

Name	Type
event	"ready"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:255

▸ once(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:256

▸ once(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.once

Defined in

node_modules/@types/node/fs.d.ts:257

---

pipe

▸ pipe<T>(destination, options?): T

Type parameters

Name	Type
T	extends WritableStream<T>

Parameters

Name	Type
destination	T
options?	Object
options.end?	boolean

Returns

T

Inherited from

stream.Writable.pipe

Defined in

node_modules/@types/node/stream.d.ts:10

---

prependListener

▸ prependListener(event, listener): WriteStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:259

▸ prependListener(event, listener): WriteStream

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:260

▸ prependListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:261

▸ prependListener(event, listener): WriteStream

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:262

▸ prependListener(event, listener): WriteStream

Parameters

Name	Type
event	"open"
listener	(fd: number) => void

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:263

▸ prependListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:264

▸ prependListener(event, listener): WriteStream

Parameters

Name	Type
event	"ready"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:265

▸ prependListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:266

▸ prependListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.prependListener

Defined in

node_modules/@types/node/fs.d.ts:267

---

prependOnceListener

▸ prependOnceListener(event, listener): WriteStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:269

▸ prependOnceListener(event, listener): WriteStream

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:270

▸ prependOnceListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:271

▸ prependOnceListener(event, listener): WriteStream

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:272

▸ prependOnceListener(event, listener): WriteStream

Parameters

Name	Type
event	"open"
listener	(fd: number) => void

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:273

▸ prependOnceListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:274

▸ prependOnceListener(event, listener): WriteStream

Parameters

Name	Type
event	"ready"
listener	() => void

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:275

▸ prependOnceListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:276

▸ prependOnceListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Overrides

stream.Writable.prependOnceListener

Defined in

node_modules/@types/node/fs.d.ts:277

---

rawListeners

▸ rawListeners(event): Function[]

Parameters

Name	Type
event	string | symbol

Returns

Function[]

Inherited from

stream.Writable.rawListeners

Defined in

node_modules/@types/node/events.d.ts:71

---

removeAllListeners

▸ removeAllListeners(event?): WriteStream

Parameters

Name	Type
event?	string | symbol

Returns

WriteStream

Inherited from

stream.Writable.removeAllListeners

Defined in

node_modules/@types/node/events.d.ts:67

---

removeListener

▸ removeListener(event, listener): WriteStream

Parameters

Name	Type
event	"close"
listener	() => void

Returns

WriteStream

Inherited from

stream.Writable.removeListener

Defined in

node_modules/@types/node/stream.d.ts:227

▸ removeListener(event, listener): WriteStream

Parameters

Name	Type
event	"drain"
listener	() => void

Returns

WriteStream

Inherited from

stream.Writable.removeListener

Defined in

node_modules/@types/node/stream.d.ts:228

▸ removeListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Inherited from

stream.Writable.removeListener

Defined in

node_modules/@types/node/stream.d.ts:229

▸ removeListener(event, listener): WriteStream

Parameters

Name	Type
event	"finish"
listener	() => void

Returns

WriteStream

Inherited from

stream.Writable.removeListener

Defined in

node_modules/@types/node/stream.d.ts:230

▸ removeListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Inherited from

stream.Writable.removeListener

Defined in

node_modules/@types/node/stream.d.ts:231

▸ removeListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Inherited from

stream.Writable.removeListener

Defined in

node_modules/@types/node/stream.d.ts:232

▸ removeListener(event, listener): WriteStream

Parameters

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

Returns

WriteStream

Inherited from

stream.Writable.removeListener

Defined in

node_modules/@types/node/stream.d.ts:233

---

setDefaultEncoding

▸ setDefaultEncoding(encoding): WriteStream

Parameters

Name	Type
encoding	BufferEncoding

Returns

WriteStream

Inherited from

stream.Writable.setDefaultEncoding

Defined in

node_modules/@types/node/stream.d.ts:161

---

setMaxListeners

▸ setMaxListeners(n): WriteStream

Parameters

Name	Type
n	number

Returns

WriteStream

Inherited from

stream.Writable.setMaxListeners

Defined in

node_modules/@types/node/events.d.ts:68

---

uncork

▸ uncork(): void

Returns

void

Inherited from

stream.Writable.uncork

Defined in

node_modules/@types/node/stream.d.ts:166

---

write

▸ write(chunk, cb?): boolean

Parameters

Name	Type
chunk	any
cb?	(error: undefined | null | Error) => void

Returns

boolean

Inherited from

stream.Writable.write

Defined in

node_modules/@types/node/stream.d.ts:159

▸ write(chunk, encoding, cb?): boolean

Parameters

Name	Type
chunk	any
encoding	BufferEncoding
cb?	(error: undefined | null | Error) => void

Returns

boolean

Inherited from

stream.Writable.write

Defined in

node_modules/@types/node/stream.d.ts:160

---

listenerCount

▸ Static listenerCount(emitter, event): number

deprecated since v4.0.0

Parameters

Name	Type
emitter	EventEmitter
event	string | symbol

Returns

number

Inherited from

stream.Writable.listenerCount

Defined in

node_modules/@types/node/events.d.ts:31

---

on

▸ Static on(emitter, event): AsyncIterableIterator<any>

Parameters

Name	Type
emitter	EventEmitter
event	string

Returns

AsyncIterableIterator<any>

Inherited from

stream.Writable.on

Defined in

node_modules/@types/node/events.d.ts:28

---

once

▸ Static once(emitter, event): Promise<any[]>

Parameters

Name	Type
emitter	NodeEventTarget
event	string | symbol

Returns

Promise<any[]>

Inherited from

stream.Writable.once

Defined in

node_modules/@types/node/events.d.ts:26

▸ Static once(emitter, event): Promise<any[]>

Parameters

Name	Type
emitter	DOMEventTarget
event	string

Returns

Promise<any[]>

Inherited from

stream.Writable.once

Defined in

node_modules/@types/node/events.d.ts:27