Anchor

fasten your apps!

Tiny (>1kb) library to create a unique global application registry.

Useful for composing single-page-apps or developing a Micro-Frontend architecture

API

Anchor([options = {}])

• options {Object} (optional)
  • register {Object} - initial object registry (optional)
  • global {Object} - global object to anchor to (default {})
  • mixins {Array} - extend achor directly

Quick Start

Anchor is the superfood for your application entry file

// app.js

import anchor from 'anchor.js';

let app = Anchor();

app.register('version', '1.0.0');
app.register('log', console);

export app;

Now app can do

// another.js

import app from 'app.js';

app.log.info('using app version', app.version); // using app version 1.0.0

You can also initialize Anchor with an object to front-loaded the registry via opts.register instead of using app.register()

let app = new Anchor({
    register: {
        'version': '1.0.0',
        'log': console,
        ...
    }
});

TIP: Connect multiple spas together, on each spa use app.register to extend that spas functionality on its bootstrap file

The Anchor options.mixins acts more like a merge, rather than a registry and is useful to mixin to the anchor directly, for example:

// app.js

import anchor from 'anchor.js';
import mitt from 'mitt.js'; // event library

let app = new Anchor({mixins: [mitt()]}); // adds on, off, emit, all to app

app now has on, off, emit, and all event functions bolted on (unsafe), so you can do

app.on('my-event', dostuff);

Of course we are only talking about not using a namespace vs not using a namespace. You can achieve the same thing with app.register('events', mitt()) and it is safer, but a tiny bit more typing :)

app.events.emit('my-event', " I'm your huckel berry");

WARNING: mixins have no safe guards and WILL overwrite duplicates

Tests

npm test

NOTE: requires deno to execute module-based client-side test runner

and lint via

npm run lint

Support

Please open an issue for support.

Contributing

Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines, they're minimalistic;)

License

MIT 2021 Geoff Doty