potion-client

Potion

A TypeScript client for APIs written in Flask-Potion.

Table of Contents

• Installation
• Usage
  • API
  • Angular
  • AngularJS
  • Fetch
• Contribute

Installation

---

Install this package with NPM:

$(node bin)/npm install potion-client

Or Yarn:

yarn install potion-client

It can also be used with JSPM:

$(npm bin)/jspm install potion=npm:potion-client

Usage

---

Before you use this package, make sure you include reflect-metadata and a shim for ES6/7 features (core-js has the most comprehensive collection of shims and I advise using it).

Furthermore, this package has multiple implementations available, it can be used with:

• Fetch, using Fetch API (make sure to include a polyfill such as whatwg-fetch if you are targeting a browser that does not implement the API);
• Angular;
• AngularJS.

IMPORTANT: All resource properties that are retrieved from the backend will be converted from snake case to camel case, so the following:

class Foo(db.Model):
    bar_name = db.Column(db.String(256), nullable=True)

Will match the following resource on the client side:

class Foo extends Item {
    barName: string;
}

Contribute

---

If you'd like to contribute:

1. Clone the repository git clone https://github.com/biosustain/potion-node;
2. Install all the deps yarn install/npm install.

Now you can start hacking :)

Before you make a pull request, make sure that the builds and tests will run successfully:

1. Run the tests using npm run test (if you wish to run tests on file change, use npm run test:continuous);
2. Lint the code with npm run lint;
3. Use npm run build to build the .ts files and see if any errors have occurred.

If you're a contributor and you wish to publish the package, make sure you update the package version in package.json according to the semver spec and:

make publish