Skip to content
Append a buffer to another buffer ensuring to preserve line ending characters.
JavaScript
Branch: master
Clone or download
Latest commit ee617be Aug 1, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github run update Aug 1, 2017
.editorconfig run update Aug 1, 2017
.eslintrc.json run update Aug 1, 2017
.gitattributes first commit Aug 1, 2017
.gitignore run update Aug 1, 2017
.travis.yml run update to add CI configurations Aug 1, 2017
.verb.md initialize and configure verb Aug 1, 2017
LICENSE run update Aug 1, 2017
README.md run verb to generate readme Aug 1, 2017
appveyor.yml run update to add CI configurations Aug 1, 2017
index.js return early when suffix is empty Aug 1, 2017
package.json 1.0.2 Aug 1, 2017
test.js return early when suffix is empty Aug 1, 2017

README.md

append-buffer NPM version NPM monthly downloads NPM total downloads Linux Build Status Windows Build Status

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

Copyright © 2017, Brian Woodward. Released under the MIT License.


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

You can’t perform that action at this time.