Skip to content

Latest commit

 

History

History

client-node

README.md

Nymph Node Client

Powerful object data storage and querying.

The Nymph Node Client lets you do everything the Nymph Client does, but from Node.JS instead of the browser.

Installation

npm install --save @nymphjs/client-node

This package is the Nymph client for Node.js. You can find ES modules in dist, or TS source in src. There is also a browser client.

This package provides fetch and WebSocket ponyfills to Nymph and handles Tilmeld auth tokens.

Usage

To use, require it instead of @nymphjs/client:

const { Nymph, PubSub } = require('@nymphjs/client-node');

Then set up Nymph and PubSub like normal:

const nymphOptions = {
  restUrl: 'https://yournymphrestserver/path/to/your/endpoint',
  pubsubUrl: 'wss://yournymphpubsubserver',
};
const nymph = new Nymph(nymphOptions);
const pubsub = new PubSub(nymphOptions, nymph);

License

Copyright 2021-2024 SciActive Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.