escape-code

ANSI Escape Code as an object

Usage

Provides a constructor that takes a single, string argument, and simply wraps that string value. Presently it offers no utility beyond being able to do an instanceof check. I use this in a stream so that consumers can differentiate between escape codes and normal strings.

var EscapeCode = require('escape-code');
var assert = require('assert');
 
var code = new EscapeCode('\u001b[32m');
 
// this is the useful bit
assert(code instanceof EscapeCode);
// or
assert(code.isEscapeCode);    // boolean value === true
 
// toString just returns what you put in.
assert.equal(code.toString(), '\u001b[32m');
 
// toValue is overridden, so you can do non-strict comparison
assert.equal(code, '\u001b[32m');
  
// and with regularExpressions
 
assert(/\u001b/.test(code));
assert.equal(/\u001b/.exec(code)[0], '\u001b');
 

Each instance has the following delegate methods that will be called on the underlying String.

• charAt
• charCodeAt
• concat
• indexOf
• lastIndexOf
• match
• replace
• search
• slice
• split
• substr
• substring
• toLowerCase
• toUpperCase
• trim

License

MIT © James Talmage