@playstack/nest-feeds

@playstack/nest-feeds connects feed regeneration definitions to an application-owned queue and scheduler without selecting BullMQ, cron, or another provider.

Install

After confirming preview access, install the package at your application's shared Playstack version:

npm install --save-exact @playstack/nest-feeds@0.1.0-beta.1

Check the peer requirements below before choosing a runtime or provider.

Compose the module

const generationQueue = new NestFeedGenerationQueue({
  dispatch: (name, payload, { jobId }) => jobs.add(name, payload, { jobId }),
})

PlaystackFeedsModule.forRoot({
  queue: generationQueue,
  namespace: 'marketing',
  definitions: [
    {
      id: 'public',
      generate: (job) => generatePublicDocuments(job.reason),
    },
  ],
  scheduledDefinitionIds: ['public'],
  onScheduleError: (error, definitionId) => report(error, definitionId),
})

Configuration reference

Configuration is validated and frozen at module creation. Use forRootAsync({ imports, inject, useFactory }) for DI-resolved setup.

Regeneration and worker bridges

Inject PlaystackFeedRegenerationService and call request(definitionId, reason) for content-change, manual, or scheduled work. All reasons use the same feeds:<namespace>:<definitionId> job ID so the queue coalesces overlap.

The queue client bridge dispatches the fixed playstack.feeds.generate job. Bind it to PlaystackFeedGenerationConsumer.handle(job.data) in the worker; recovered payloads are validated and may invoke only a registered definition.

Call PlaystackFeedScheduler.tick() from the application scheduler. Ticks never overlap; one definition’s failure does not block later requests.

Boundary

The package installs no scheduler or queue framework. Applications own cron cadence, broker lifecycle, queue processor registration, and storage; the core feed package owns generation behavior.

API entry points and requirements

Reference snapshot: @playstack/nest-feeds@0.1.0-beta.1. Import only the entry point your runtime needs. Paths below are relative to the installed package; use Go to Definition in your editor to inspect exact parameters, return types and overloads. Do not import the declaration-file paths directly.

Node.js engine requirement: >=20. This is not a claim that every entry point works in browsers or Workers.

Peer dependencies

Keep existing framework versions that satisfy these ranges. Install optional peers only when using the corresponding adapter. The package manager resolves ordinary dependencies separately.

For a complete first program, start with Getting started. For API lookup and partial-example conventions, see Reading the reference. Provider failures, lifecycle requirements and application responsibilities remain described in the guide above; types alone do not establish production safety.