@x/serverless.host

Host process for @x/serverless

Standalone Installation

@x/serverless can be configured to run in-process in any Javascript environment with a supported data store (IndexedDB and any of the SQL databases supported by knex). Use the following steps to install for a browser in a React application using IndexedDB.

Install Dependencies

yarn add @x/serverless.host @x/serverless.react

Configure React Bindings

Modify src/index.js to wrap your App component in a Provider:

import React from 'react'
import ReactDOM from 'react-dom'
import { Provider } from '@x/serverless.react'
import App from './App'
import host from '@x/serverless.host'

ReactDOM.render(
  <Provider host={host()}><App /></Provider>,
  document.getElementById('root')
)

Aspects

The @x/serverless host provides the following aspects:

Property Aspects

uuid

Sets the property to a random universally unique identifier.

Call Aspects

open

Allows external access to the vocabulary with any scope.

scoped(...scopeProperties)

Allows external access to the vocabulary with the specified scope properties set. Pass no parameters to enforce access to the global scope.

strictApi

Used internally by the strictApi configuration option to ensure the vocabulary has been marked as "public".