README.md

Nymph Node Client - collaborative app data

Powerful object data storage and querying for collaborative web apps.

Deprecation Notice

The PHP implementation of Nymph/Tilmeld has been deprecated. It will no longer have any new features added. Instead, a new version of Nymph running on Node.js, written entirely in TypeScript will replace the PHP implementation. You can find it over at the Nymph.js repo.

Installation

npm install --save nymph-client-node

This repository is the JavaScript client for Node. There is also a browser client. For more information, you can see the main Nymph repository.

This package provides fetch and WebSocket ponyfills to Nymph, handles Tilmeld auth tokens, and sets up Nymph.init to also call PubSub.init with your configs if you provide a pubsubURL.

Usage

To use, require it instead of nymph-client:

const { Nymph } = require("nymph-client-node");

Then provide the options to Nymph.init:

Nymph.init({
  restURL: "https://yournymphrestserver/path/to/your/rest.php",
  pubsubURL: "wss://yournymphpubsubserver",
});

For a thorough step by step guide to setting up Nymph on your own server, visit the Setup Guide.

API Docs

Check out the API Docs in the wiki.