Skip to main content
Skip to main content

TransformOptions

Properties

allowHalfOpenboolean
autoDestroyboolean
decodeStringsboolean
defaultEncodingBufferEncoding
emitCloseboolean
highWaterMarknumber
objectModeboolean
readableHighWaterMarknumber
readableObjectModeboolean
signalAbortSignal
When provided the corresponding AbortController can be used to cancel an asynchronous action.
writableCorkednumber
writableHighWaterMarknumber
writableObjectModeboolean

Methods

construct

Parameters

thisTransformRequired
callback(error?: null | Error) => voidRequired

Returns

voidvoid

destroy

Parameters

thisTransformRequired
errornull | ErrorRequired
callback(error: null | Error) => voidRequired

Returns

voidvoid

final

Parameters

thisTransformRequired
callback(error?: null | Error) => voidRequired

Returns

voidvoid

flush

Parameters

thisTransformRequired
callbackTransformCallbackRequired

Returns

voidvoid

read

Parameters

thisTransformRequired
sizenumberRequired

Returns

voidvoid

transform

Parameters

thisTransformRequired
chunkanyRequired
encodingBufferEncodingRequired
callbackTransformCallbackRequired

Returns

voidvoid

write

Parameters

thisTransformRequired
chunkanyRequired
encodingBufferEncodingRequired
callback(error?: null | Error) => voidRequired

Returns

voidvoid

writev

Parameters

thisTransformRequired
chunks{ chunk: any ; encoding: [BufferEncoding](/references/js-client/internal/types/internal.BufferEncoding) }[]Required
callback(error?: null | Error) => voidRequired

Returns

voidvoid
Was this section helpful?