# @northtech/ratatosk

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

Latest version **2.4.0-rc.1** (published 2022-09-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install @northtech/ratatosk
pnpm add @northtech/ratatosk
yarn add @northtech/ratatosk
bun add @northtech/ratatosk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.0-rc.1 |
| Published | 2022-09-23 |
| First published | 2021-03-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 133.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | JWN |
| Maintainers | wulfsberg |

## Links

- npm: https://www.npmjs.com/package/@northtech/ratatosk
- npm.io page: https://npm.io/package/@northtech/ratatosk

## Dependencies (1)

- [ts-essentials](https://npm.io/package/ts-essentials.md) ~9.2

## Recent versions

- 2.4.0-rc.1 (latest) — 2022-09-23
- 2.3.3-rc.1 — 2022-05-09
- 2.3.3-rc.0 — 2022-05-06
- 2.3.2 — 2022-04-13
- 2.3.1 — 2022-04-12
- 2.3.0 — 2022-03-27
- 2.3.0-rc.0 — 2022-03-01
- 2.2.1 — 2022-02-21
- 2.2.0 — 2022-02-18
- 2.2.0-rc.3 — 2022-02-17
- 2.2.0-rc.2 — 2022-02-17
- 2.2.0-rc.1 — 2022-02-17
- 2.2.0-rc.0 — 2022-02-17
- 2.1.1-rc.1 — 2022-02-16
- 2.1.1-rc.0 — 2022-02-15
- … 14 more at https://npm.io/package/@northtech/ratatosk/versions

## README

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.

#### Observable store
An object which emits its data (or subsets of it) as each field is set or changed. This can be used to maintain
application state or configuration.  
(This tastes a little Redux-y, but is implemented more as a utility library leveraging RxJs than as a framework).

#### 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@^2.1

Install peer dependency if needed:

    npm install rxjs@^7

TypeDocs at https://doc.northtech.dk/ratatosk/

---
_Source: https://npm.io/package/@northtech/ratatosk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
