immutable-core-service v0.3.0

immutable-core-service

Immutable Core Service integrates with the Immutable App ecosystem to provide persistent global services backed by shared immutable data state that can be reinitialized on a periodic basis.

Immutable Core Service is designed to support use cases like app configuration and access control that use data from Immutable Core Models but that data does not change from one request to the next.

Immutable Core Service requires native async/await support.

Creating a new service

var fooService = new ImmutableCoreService({
    name: 'foo',
    methods: {
        foo: function (args) { ... },
    },
    initialize: function (args) { .. },
    reinitializeInterval: 10,
})

In this example a service named foo is defined with a single foo method.

This will create an Immutable Core module with the module name fooService and two methods: foo and initialize.

The initialize method is called once when the service is first created and is then called at an interval defined by reinitializeInterval which is in seconds.

The data object returned by initialize will become the shared state for the service.

Data is stored in the module data and can be accessed via fooService.module.data.

Initializing services

await ImmutableCoreService.initializeAll()

The initializeAll method will call the initialize method for each globally registered service and resolve once all services have been initialized.

After all services have been initialized the global reinitialize check will be started.

Starting reinitialize check

ImmutableCoreService.reinitializeStart()

reinitializeStart sets an interval that will call reinitializeCheck every 1 second (1000ms).

This is called by initializeAll once it completes.

Stopping reinitialize check

ImmutableCoreService.reinitializeStop()

reinitializeStop clears the interval set by reinitializeStart. It does not abort any initialize calls in progress.