svc-registry v1.0.0

js-svc-registry

A JavaScript service registry.

Usage

npm install svc-registry

In your main file you can create a new service registry

const SvcRegistry = require('svc-registry');

const sr = new SvcRegistry();

Then register some services

const sr = require('svc-registry').getRegistry();
// this is the same sr as in the main file

const service1Impl = new Service1();

const service2Impl = new Service2('foo/bar/baz');
service2Impl.setType(Service2.types.SOME_TYPE);

sr.register(Service1, service1);
sr.register(Service2, service2);

You can then access those services from anywhere

const sr = require('svc-registry').getRegistry();

const service1Impl = sr.get(Service1);
// this is the same service1Impl as we registered

You can also replace existing services, unregister services, create additional named registries, and destroy registries.

Method Reference

SvcRegistry

The constructor can be called with no argument or with a single argument. The single argument is the name of the registry. This allows multiple service registries to be created.

getRegistry

This static method will get a service registry by name. If the argument is omitted, the default service registry is returned.

register

This method takes two arguments. The first is the key for the service that you are registering (typically the class reference, but it can be a string) and the second is the instance itself.

replace

This method takes identical arguments to register, but is intended for replacing an existing service. Whereas register will throw an error if you instruct it to overwrite an existing service, replace will not.

unregister

This method takes a single argument: the key for the service that you want to unregister. After unregistered, the instance will no longer be accessible through the service registry.

get

Given a key (class reference), get gets and returns a registered service.

destroy

This method destroys the service registry. A deleted service registry can no longer be found using getRegistry, and existing references to it will not work.

destroyAllRegistries

EXPERIMENTAL

Testing

npm test