⚠️ Internal: This API is not publically exported by the
package.
Interface WritableOptions<T>
Methods
Optional construct
- construct(this, callback): void
Parameters
this: T
callback: ((error?) => void)
- (error?): void
Returns void
Returns void
Optional destroy
- destroy(this, error, callback): void
Parameters
this: T
callback: ((error?) => void)
- (error?): void
Returns void
Returns void
Optional final
- final(this, callback): void
Parameters
this: T
callback: ((error?) => void)
- (error?): void
Returns void
Returns void
Optional write
- write(this, chunk, encoding, callback): void
Parameters
this: T
chunk: any
callback: ((error?) => void)
- (error?): void
Returns void
Returns void
Optional writev
- writev(this, chunks, callback): void
Parameters
this: T
chunks: {
chunk: any;
encoding: BufferEncoding;
}[]
callback: ((error?) => void)
- (error?): void
Returns void
Returns void
Properties
Optional autoDestroy
autoDestroy?: boolean
Optional decodeStrings
decodeStrings?: boolean
Optional emitClose
emitClose?: boolean
Optional highWaterMark
highWaterMark?: number
Optional objectMode
objectMode?: boolean
When provided the corresponding
AbortControllercan be used to cancel an asynchronous action.