@skylernpm/et-placeat-nobis v1.0.0

@skylernpm/et-placeat-nobis

Replacement for util.inspect and the console object.

var @skylernpm/et-placeat-nobis = require('@skylernpm/et-placeat-nobis');

var str = @skylernpm/et-placeat-nobis.inspect({ foo: 'bar' }); // "{ foo: 'bar' }"

@skylernpm/et-placeat-nobis.log('foo', { bar: /hey/ }); // { bar: /hey/ }

// Or use this shorthand:
@skylernpm/et-placeat-nobis('foo', { bar: /hey/ }); // { bar: /hey/ }

The library also includes diffing support (powered by Unexpected's diffing engine):

@skylernpm/et-placeat-nobis.diff({ foo: 'bar' }, { foo: 'baz' });
{
  foo: 'bar'; // should be 'baz'
  // -bar
  // +baz
}

Or if you want to get the rendered diff as a string:

const diff = @skylernpm/et-placeat-nobis.diffAsString({ foo: 'bar' }, { foo: 'baz' });

You can use the equal function if you just want to compare two values for equality:

@skylernpm/et-placeat-nobis.equal({ foo: 123 }, { foo: 123 }); // returns true
@skylernpm/et-placeat-nobis.equal({ abc: 123 }, { def: 456 }); // returns false

You can also ask for the diff with ANSI codes, or in HTML format:

const ansiDiff = @skylernpm/et-placeat-nobis.diffAsString(
  { foo: 'bar' },
  { foo: 'baz' },
  { format: 'ansi' }
);
const htmlDiff = @skylernpm/et-placeat-nobis.diffAsString(
  { foo: 'bar' },
  { foo: 'baz' },
  { format: 'html' }
);

You can also use it instead of the console object:

var console = require('@skylernpm/et-placeat-nobis');

console.log('...');

console.trace();

In the Chrome console this will produce colored output using this API.

The @skylernpm/et-placeat-nobis npm package includes a bookmarklet for doing the above, ie. replacing the console object with @skylernpm/et-placeat-nobis, see bookmarklet.html at the root of the package. Unfortunately github doesn't permit putting it directly into this README.

RELEASES

See the changelog.