Tilmeld Client

The Tilmeld Client lets you register, login, and perform user account related functions remotely on a Nymph server.

Installation

npm install --save @nymphjs/tilmeld-client

You can find UMD in dist, or TS source in src.

Usage

The Tilmeld client contains the client versions of the User and Group entities. It also contains helpers, getClientConfig, login, register, and checkUsername.

Once you've initialized Nymph Client, set the User and Group classes on it.

import { Nymph } from '@nymphjs/client';
import { User, Group } from '@nymphjs/tilmeld-client';

const nymph = new Nymph({
  restUrl: 'https://yournymphrestserver/path/to/your/endpoint',
});
nymph.addEntityClass(User);
nymph.addEntityClass(Group);

If you're running more than one instance of Nymph client, you can clone the classes and add those instead. This will keep event listeners and Tilmeld client config separated.

import { Nymph } from '@nymphjs/client';
import { User, Group } from '@nymphjs/tilmeld-client';

const nymph = new Nymph({
  restUrl: 'https://yournymphrestserver/path/to/your/endpoint',
});
const UserClone = User.clone();
nymph.addEntityClass(UserClone);
const GroupClone = Group.clone();
nymph.addEntityClass(GroupClone);