@forestvpn/forestvpn_cloud_api

A package to interact ForestVPN Cloud API (manage vpn profiles, check usage statistics, and many other)


Keywords
wireguard, api, rest, wgrest, restful, vpn, tunneling, wg, forestvpn, wireguard-ui, vpn-ui, vpn-rest, vpn-api, cloud
License
MIT
Install
npm install @forestvpn/forestvpn_cloud_api@0.7.2

Documentation

ForestVPN Cloud API Client

ForestVPN Cloud - it's a Google Cloud but for VPN apps. Ready to use VPN Cloud Platform minimizes efforts to build fast, secure, and modern VPN apps.

For more information, please visit https://forestvpn.com/

Environment

  • Node.js
  • Webpack
  • Browserify

Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

Module system

  • CommonJS
  • ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @ --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Author

ForestVPN support@forestvpn.com

Credits