Methods

(static) split(buffer, options) → {Promise.<Array.<Buffer>>}

Split buffer.

Parameters:
NameTypeDescription
bufferBuffer

Buffer to split.

optionsObject

Splitting options.

Properties
NameTypeAttributesDescription
linesnumber<optional>

Number of lines to put per output files.

bytesnumber | string<optional>

Number of bytes to put per output files.

line_bytesnumber | string<optional>

Number of bytes to put at most per output files.

prefixstring<optional>

Output file names prefix.

suffix_lengthnumber<optional>

Length of suffixes.

additional_suffixstring<optional>

Additional suffix of file names.

numeric_suffixesnumber<optional>

Start number of numeric suffixes.

Source
Returns:
Type: 
Promise.<Array.<Buffer>>

(static) splitSync(buffer, options) → {Array.<Buffer>}

Split buffer synchronously.

Parameters:
NameTypeDescription
bufferBuffer

Buffer to split.

optionsObject

Splitting options. See module:merked/split.split.

Source
Throws:

Throws an error when options are invalid or when running out of suffixes.

Returns:

Array of splitted buffer

Type: 
Array.<Buffer>