About
Ion-JS is a Javascript library for Ion. The library allows for reading/writing Ion
data from within Javascript code.
For more information on Ion have a look at the Ion Specification as well as some of the other Ion language specific libraries such as
Download
The library is written in typescript and uses npm
for its dependencies. Make sure you have the latest, stable, release
for npm
.
- Clone this repo
git clone --recursive https://github.com/amzn/ion-js.git
- Use
npm
to install all dependencies
npm install
- We use
grunt
for managing our build process, to see all of our build targets look at Gruntfile.js
.
grunt all
Javascript code is generated under the folder dist
.
Documentation is generated under the folder doc
and is also available online.
Tests
To debug the unit tests, use the following command:
node debug node_modules/intern/client config=tests/intern ionVersion=es6
Browser
To run Ion in a browser, see the example in the "browser" folder. You'll need to copy require.js and the Ion JavaScript files (Ion.js etc.) into the "scripts" folder.