@flipdish/restaurant-config

This package provides a Typescript/JavaScript client for interacting with Flipdish's Restaurant Config APIs over HTTP.

Internally the package utilizes the axios as its HTTP client.

Example code

// import { Configuration } from '@flipdish/restaurant-config';
import { describe, test } from '@jest/globals';

// const configuration = new Configuration({
//   basePath: 'https://api.flipdish.co',
//   // For browser projects set useDefaultUserAgent: true
//   // useDefaultUserAgent: true,
//   // Optionally provide a token during testing:
//   // accessToken: process.env.FLIPDISH_BEARER_TOKEN,
// });

describe('Restaurant Config SDK', () => {
  test('build/load', async () => {
    // smoke test only
  });
});

The generated Node module can be used in the following environments:

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