Gopad: SDK for Javascript

This repository provides a client SDK for Typescript/Javascript. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0-alpha1
• Package version: 2.1.0
• Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen

For more information, please visit https://gopad.eu

Environments

• 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 will be automatically resolved via package.json.

Installation

Installation with NPM

If you want to use one of the versions released via NPM you just need to execute the following command within your project directory, after that you can import it as other libraries:

npm install --save [email protected]

Installation with Git

If you want to use an unreleased version hosted on our GitHub repository you can execute the folling command within your project directory, after that you can import it as other libraries:

npm install --save https://github.com/gopad/gopad-js

Building

To build and compile the Typescript sources to Javascript simply execute the following commands and you are ready to go:

npm install
npm run build

Security

If you find a security issue please contact [email protected] first.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

• Thomas Boerger

License

Apache-2.0

Copyright

Copyright (c) 2018 Thomas Boerger <[email protected]>