oro-client v0.1.0

oro-client

ORO Client component is intended to wrap all back-end interaction logic.

Warning: only browsers can make use this component.

Requirements

• npm 6.14.11

Getting started

This package is intended to work in a SSR ready web server (tested with Sapper).

In order to import it you'll need to:

• Set the server to serve statically the wasm binary
• Initialise this component

Server side only

You'll find the wasm to serve location under wasmPath. The component expects to fetch it at [server url]/oro_toolbox_bg.wasm

Note: in a Sapper application you'll prefer to do that in the server.ts

Client side only

You have to initialise the component as follow:

import init from 'oro-client';
init();

Note: in a Sapper application you'll prefer to do that in the client.ts

The initialised toolboxModule being a Svelte store you can derive it in order to safely wait for its initialisation.

Local development

Set up project

npm install

Then, it's possible to either build/watch component by using

npm start # watch
npm build # build

Import this locally (without having to publish it)

Use npm link

In this dir use. It will build and link your dist folder.

npm link

# Optional command, will rebuild on save and reload your dependent app
npm start

On the dependent app

npm link oro-client

Note: Please set wasmPath variable as asked in src/index.ts

Caveat: There is some caveat using npm link please see doc