⚠️ Internal: This API is not publically exported by the
package.
Interface DuplexOptions<T>
interface DuplexOptions { allowHalfOpen?: boolean; autoDestroy?: boolean; decodeStrings?: boolean; defaultEncoding?: BufferEncoding; emitClose?: boolean; encoding?: BufferEncoding; highWaterMark?: number; objectMode?: boolean; readableHighWaterMark?: number; readableObjectMode?: boolean; signal?: AbortSignal; writableCorked?: number; writableHighWaterMark?: number; writableObjectMode?: boolean; construct?(this,
callback): void; destroy?(this,
error,
callback): void; final?(this,
callback): void; read?(this,
size): void; write?(this,
chunk,
encoding,
callback): void; writev?(this,
chunks,
callback): void; } 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 read
- read(this, size): 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 allowHalfOpen
allowHalfOpen?: boolean
Optional autoDestroy
autoDestroy?: boolean
Optional decodeStrings
decodeStrings?: boolean
Optional emitClose
emitClose?: boolean
Optional highWaterMark
highWaterMark?: number
Optional objectMode
objectMode?: boolean
Optional readableHighWaterMark
readableHighWaterMark?: number
Optional readableObjectMode
readableObjectMode?: boolean
Optional writableCorked
writableCorked?: number
Optional writableHighWaterMark
writableHighWaterMark?: number
Optional writableObjectMode
writableObjectMode?: boolean
When provided the corresponding
AbortControllercan be used to cancel an asynchronous action.