Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tools
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
LICENCE
Makefile
README.md
index.js
jsdoc.conf.json
package.json

README.md

core.inspect

Build status NPM version Dependencies status Licence Stable API

Displays a human-readable representation of built-in and custom objects

Example

var show = require('core.inspect');

show([1, { foo: true }, "qux" ]);
// => '[1, {"foo": true}, "qux"]'

show([1, [2, [3, [4, [5, [6, [7]]]]]]]);
// => '[1, [2, [3, [4, [5, (...)]]]]]'

show({ foo: { toString: function(){ return "Yay" }}});
// => '{"foo": Yay}'

Installing

The easiest way is to grab it from NPM. If you're running in a Browser environment, you can use Browserify

$ npm install core.inspect

Using with CommonJS

If you're not using NPM, Download the latest release, and require the core.inspect.umd.js file:

var Inspect = require('core.inspect')

Using with AMD

Download the latest release, and require the core.inspect.umd.js file:

require(['core.inspect'], function(Inspect) {
  ( ... )
})

Using without modules

Download the latest release, and load the core.inspect.umd.js file. The properties are exposed in the global Folktale.Core.Inspect object:

<script src="/path/to/core.inspect.umd.js"></script>

Compiling from source

If you want to compile this library from the source, you'll need Git, Make, Node.js, and run the following commands:

$ git clone git://github.com/Folktale/core.inspect.git
$ cd core.inspect
$ npm install
$ make bundle

This will generate the dist/core.inspect.umd.js file, which you can load in any JavaScript environment.

Documentation

You can read the documentation online or build it yourself:

$ git clone git://github.com/Folktale/core.inspect.git
$ cd core.inspect
$ npm install
$ make documentation

Then open the file docs/index.html in your browser.

Platform support

This library assumes an ES5 environment, but can be easily supported in ES3 platforms by the use of shims. Just include es5-shim :)

Licence

Copyright (c) 2014 Quildreen Motta.

Released under the MIT licence.