@edd-kernel/provider-in-memory
v0.2.0-alpha.1
Published
In-memory EDD Kernel provider for local development and tests.
Maintainers
Readme
@edd-kernel/provider-in-memory
In-memory EDD Kernel provider for local development, examples and contract tests.
This package belongs to the EDD Kernel provider layer. It owns the in-process
transport implementation for the shared @edd-kernel/contracts client contract.
It should not be used as durable production infrastructure.
Repository: brunnofoggia/edd-kernel-js
Install
npm install @edd-kernel/contracts @edd-kernel/provider-in-memoryFor provider-name based client creation, install @edd-kernel/factory in place of the
contract. It brings the contract and re-exports it:
npm install @edd-kernel/factory @edd-kernel/provider-in-memoryUsage
import { createInMemoryClient } from '@edd-kernel/provider-in-memory';
const client = createInMemoryClient({ createIfNotExists: true });
await client.consume({ queueName: 'jobs' }, async (event, context) => {
console.log(event);
await context.ack();
});
await client.send({ queueName: 'jobs' }, { type: 'example' });You can also create this provider through @edd-kernel/factory:
import { EddProviderName, createEddClient } from '@edd-kernel/factory';
const client = await createEddClient({
providerName: EddProviderName.InMemory,
createIfNotExists: true,
});The package also exports InMemoryEddClient for direct construction and
inheritance. Its static provider identity is in-memory.
The provider supports the shared EDD Kernel options, including JSON/raw
serialization, autoIdempotencyKey, autoAck, unhandledErrorAction,
createIfNotExists and multi-queue consumption.
Addressing
InMemoryEventTarget and InMemoryEventQueue accept { queueName }, a logical name
joined with env, project and prefix. Any other address is refused by the compiler,
and at runtime with EddKernelConfigurationError.
Provider Options
queues: initial queue contents keyed by queue name. This is useful for tests that need preloaded messages.
Lifecycle
All queues are stored in memory inside the client instance. Messages are lost when the process exits or the client instance is discarded. Stopping a consumer waits for active handlers, and closing the client stops and drains all consumers. Both operations are idempotent.
