Onyx Mesh Node SDK

Usage

Get the module

The Onyx Mesh SDK is available via npm. Node 4 or greater is required.

To install, add the onyx-mesh-sdk NPM module to your package.json:

{
  "dependencies": {
    "onyx-mesh-sdk": "~2.2.4"
  }
}
Copy

TypeScript

If you're using TypeScript, include the following in your tsconfig.json:

{
  "compilerOptions": {
    "lib": ["es2015", "es2016", "esnext"],
    "types": ["node"]
  }
}
Copy

Also, run:

npm i --save-dev @types/node
Copy

In your code

const onyxMesh = require('onyx-mesh-sdk')
const ledger = new onyxMesh.Client({
  ledgerName: 'ledger',
  credential: '...',
})
Copy

Calling convention

Most SDK methods return Promise objects, which you can use with async/await, or consume directly.

With async/await:

async function main() {
  try {
    const account = await ledger.accounts.create({...})
    // operate on account
  } catch (err) {
    // handle errors
  }
}
Copy

With the Promise object itself:

function main() {
  return ledger.accounts.create({...}).then(account => {
    // operate on account
  }).catch(err => {
    // handle errors
  })
}
Copy

Documentation

Comprehensive instructions and examples are available in the developer documentation.