@nowasterio/js-client NPM

@nowasterio/js-client

@nowasterio/ts-client - JavaScript client for @nowasterio/js-client The backend API for the NoWaster App This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @nowasterio/js-client --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @nowasterio/js-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/nowaster/ts-client then install it via:

    npm install nowaster/ts-client --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var @nowasterio/ts-client = require('@nowasterio/js-client');


var api = new @nowasterio/ts-client.AdminApi()
var opts = {
  'createDrinkRequest': {"id":"a","name":"brad","ingredients":[],"alcohol_percentage":0.1,"address":"addr","weight":10,"price":100,"type":1,"menu_id":"cfbs9a07t2ulhusqili0","efficiency":0.1,"eco_points":0.1} // {CreateDrinkRequest} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDrink(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Class	Method	HTTP request	Description
@nowasterio/ts-client.AdminApi	createDrink	POST /admin/drinks	Create Drink
@nowasterio/ts-client.AdminApi	postAdminPlaces	POST /admin/places	Create Place
@nowasterio/ts-client.UserApi	getAlcoholContentSlug	GET /alcohol_content/{slug}	Get Alcohol Content for drink slug
@nowasterio/ts-client.UserApi	listPlaces	GET /places	List all places
@nowasterio/ts-client.UserApi	nowastifyDrinks	GET /places/drinks/nowastify	Nowastify Drinks
@nowasterio/ts-client.UserApi	postAutocomplete	POST /autocomplete	List Autocomplete Suggestions

Documentation for Models

Documentation for Authorization

http-basic

Type: HTTP basic authentication

@babel/cli superagent

@everything-registry/sub-chunk-668

1.0.0

1 year ago