Options
All
  • Public
  • Public/Protected
  • All
Menu

@northtech/ratatosk - v1.1.0

ratatosk

... scampers along Yggdrasil to carry messages and gossip between Nidhug at the roots and the eagle perched in the branches.

This library contains a few specialized but useful features using RxJs to pass information.

BroadcastingSet

The BroadcastingSet maintains a set of objects with IDs, and exposes Observables signaling changes to the elements in the set.

Interpolated string

Strings with placeholders, which will emit their value as an observable when the placeholder values are resolved.
This can be useful for, say, basing server URLs on late-resolving (possibly user-dependent) configuration values.

Partial object

An object (typically configuration) which emits its data as an Observable as each parameter is set or changed.
This is useful for fetching and combining configuration data asynchronously, and works well with the Interpolated strings.

Url fragment

Functionality to manipulate the URL hash fragment, treating it as a key/value store and getting information about changes to it.
An example of use is maintaining map position and zoom level in an OpenLayers application this way, allowing users to deep-link to a specific position.

Recently Used list

Keeps track of most recently used items, accorting to when they are "touched".

Usage

Install with

npm install @northtech/ratatosk@^1.1

Install peer dependency if needed:

npm install rxjs@^7

TypeDocs at https://doc.northtech.dk/ratatosk/