README.md

mysterium-vpn-js

Javascript SDK for mysteriumnetwork/node

Installation

NPM:

npm i mysterium-vpn-js

Yarn:

yarn add mysterium-vpn-js

Usage

ES6 module

import tequilapi from 'mysterium-vpn-js'

tequilapi.identityList().then((identities) => {
  console.log(identities)
})

Output:

{
  "identities": [
    { "id": "0xf2732f2100d19d74b1b5484037ebf6c13736d1bc" }
  ]
}

Node.js require syntax

const tequilapi = require('mysterium-vpn-js').default

tequilapi.healthCheck().then((res) => {
  console.log(res)
})

Output:

{
  "uptime": "75h23m14.658120675s",
  "process": 19857,
  "version":"0.2.3",
  "buildInfo": {
    "commit": "91840225277923a61de2bf5683a24532ee638559",
    "branch": "0.2.3",
    "buildNumber": "1389"
  }
}

Tequilapi Client API

See src/tequilapi-client.ts for all available Tequilapi operations.

You may also check out Tequilapi REST API documentation.

Contributing

• Run CI build: yarn ci