/ion-js

A JavaScript implementation of Amazon Ion -- this is currently alpha software and is subject to change

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Table of Contents

About

Ion-JS is a JavaScript library for Ion -- this is currently alpha software and is subject to change. 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

Use

You can use ion-js either as a Node.js module or inside an html page.

NPM

  1. Add ion-js to your dependencies using npm 
    npm install --save-dev ion-js
  2. Use the library to read/write ion data. Here is an example that reads Ion data from a JavaScript string 
    var ionJs = require("ion-js")

var ionData = "{ hello: \"Ion\" }"; 
var ionReader = ionJs.makeReader(ionData); 
ionReader.next(); 
ionReader.stepIn(); 
ionReader.next(); 
var hello = ionReader.fieldName(); 
var ion = ionReader.stringValue(); 
ionReader.stepOut(); 
console.log(ion.concat(", ").concat(hello));
    Try it yourself.

Browser

You can include the Ion-js bundle (ES5 compatible) using the URLs

These will create and initialize window.ion which has the exact API as our npm package. Here is an example

<html>
<head>
  <meta charset="UTF-8"/>
  <script src="scripts/ion-bundle.min.js"></script>

  <!-- more HTML/JS code that can now use `window.ion` to create/write Ion -->
</head>
</html>

API

Ion JS API

Contribute

CONTRIBUTE.md

License

Apache License 2.0

Links