History

jorge a7910c81a8 moved to new repo		2021-10-26 14:18:09 +02:00
..
LICENSE	moved to new repo	2021-10-26 14:18:09 +02:00
README.md	moved to new repo	2021-10-26 14:18:09 +02:00
index.js	moved to new repo	2021-10-26 14:18:09 +02:00
package.json	moved to new repo	2021-10-26 14:18:09 +02:00

README.md

append-buffer

Append a buffer to another buffer ensuring to preserve line ending characters.

Install

Install with npm:

$ npm install --save append-buffer

Install with yarn:

$ yarn add append-buffer

Usage

var appendBuffer = require('append-buffer');

API

appendBuffer

Append a buffer to another buffer ensuring to preserve line ending characters.

Params

buf {Buffer}: Buffer that will be used to check for an existing line ending. The suffix is appended to this.
suffix {Buffer}: Buffer that will be appended to the buf.
returns {Buffer}: Final Buffer

Example

console.log([appendBuffer(new Buffer('abc\r\n'), new Buffer('def')).toString()]);
//=> [ 'abc\r\ndef\r\n' ]

console.log([appendBuffer(new Buffer('abc\n'), new Buffer('def')).toString()]);
//=> [ 'abc\ndef\n' ]

// uses os.EOL when a line ending is not found
console.log([appendBuffer(new Buffer('abc'), new Buffer('def')).toString()]);
//=> [ 'abc\ndef' ]

Attribution

The code in this module was originally added in a PR to file-normalize. It has been split out to allow for standalone use cases.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Brian Woodward

License

This file was generated by verb-generate-readme, v0.6.0, on August 01, 2017.