char-buffer

char-buffer

Collect CharCodes and convert them to a string.

Installation

Node Package Manager (npm)

1. Install node.js (npm comes with node).

2. Install CharBuffer from NPM:

   npm install char-buffer
   

Bower

1. Install node.js (npm comes with node).

2. Install Bower:

   npm install bower --global
   

3. Install CharBuffer from bower.io:

   bower install char-buffer
   

Basic Usage

CharBuffer provides multiple implementations to collect CharCodes via a common interface (CharBuffer.CharBuffer):

• CharBuffer.StringBuffer uses a single String
• CharBuffer.StringArrayBuffer uses an Array of Strings
• CharBuffer.TypedArrayBuffer uses an Uint16Array
• CharBuffer.NodeBuffer uses a Node.js Buffer

var buffer;

// Create the default CharBuffer of your platform:
buffer = new CharBuffer();

// Same as before, but provide an estimate of the length of your string:
buffer = new CharBuffer(3);

// Create a specific CharBuffer implementation, if supported:
if(CharBuffer.TypedArrayBuffer.isSupported)
  buffer = new CharBuffer.TypedArrayBuffer(3);
}


// Append a CharCode:
buffer.append(102);

// Append two more CharCodes:
buffer.append(111).append(111);

// Output 'foo':
console.log(buffer.toString());

Documentations

• API
• Code Coverage Report

Examples

Node.js

// Create the default CharBuffer implementation:
var CharBuffer = require('char-buffer'),
    buffer     = new CharBuffer(3);

// Or create a specific CharBuffer implementation by CharBuffer:
var CharBuffer       = require('char-buffer'),
    TypedArrayBuffer = CharBuffer.TypedArrayBuffer,
    buffer           = new TypedArrayBuffer(3);

// Or create a specific CharBuffer implementation by package:
var TypedArrayBuffer = require('char-buffer/typed-array-buffer'),
    buffer           = new TypedArrayBuffer(3);


// Output 'foo':
console.log(buffer.append(102).append(111).append(111).toString());

Browser Globals (using Bower)

<script src="bower_components/char-buffer/char-buffer.global.js"></script>
<script>

// Create the default CharBuffer implementation:
var buffer = new CharBuffer(3);

// Or create a specific CharBuffer implementation:
var TypedArrayBuffer = CharBuffer.TypedArrayBuffer,
    buffer           = new TypedArrayBuffer(3);


// Output 'foo'
console.log(buffer.append(102).append(111).append(111).toString());

</script>

Asynchronous Module Definition (using Bower)

See Asynchronous Module Definition (AMD) for details.

<script src="path/to/your/amd/loader.js"></script>
<script src="bower_components/char-buffer/char-buffer.js"></script>
<script>

/**
 * Use the CharBuffer package:
 */
require(['char-buffer'], function(CharBuffer){
  // create the default CharBuffer implementation:
  var buffer = new CharBuffer(3);

  // Or create a specific CharBuffer implementation by CharBuffer:
  var TypedArrayBuffer = CharBuffer.TypedArrayBuffer,
      buffer = new TypedArrayBuffer(3);


  // Output 'foo'
  console.log(buffer.append(102).append(111).append(111).toString());
});


/**
  * Or use a specific CharBuffer package:
  */
require(['char-buffer/typed-array-buffer'], function(TypedArrayBuffer){

  var buffer = new TypedArrayBuffer(3);

  // Output 'foo'
  console.log(buffer.append(102).append(111).append(111).toString());
});

</script>

License

Copyright (c) 2014 Michael Mayer

Licensed under the MIT license.