Skip to main content

@terascope/core-utils / buffers

buffers

Functions​

bufferToString()​

bufferToString(input, format?): string

Defined in: packages/core-utils/src/buffers.ts:25

Parameters​

ParameterType
inputunknown
formatBufferEncoding

Returns​

string


ensureBuffer()​

ensureBuffer(input, encoding?): Buffer

Defined in: packages/core-utils/src/buffers.ts:7

Convert an input to a Buffer if possible

Parameters​

ParameterTypeDefault value
inputstring | Buffer<ArrayBufferLike>undefined
encodingBufferEncoding'utf8'

Returns​

Buffer


isBuffer()​

isBuffer(input): input is Buffer<ArrayBufferLike>

Defined in: packages/core-utils/src/buffers.ts:20

Check if an input is an nodejs Buffer

Parameters​

ParameterType
inputunknown

Returns​

input is Buffer<ArrayBufferLike>