Skip to content

docs: update Immediate.Jobs public API - #20

Merged
viceroypenguin merged 8 commits into
mainfrom
docs/immediate-jobs-pr-144
Aug 28, 2026
Merged

docs: update Immediate.Jobs public API#20
viceroypenguin merged 8 commits into
mainfrom
docs/immediate-jobs-pr-144

Conversation

@dukesteen

@dukesteen dukesteen commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Update Immediate.Jobs scheduling examples for the payload-first API, unified ScheduleAsync overloads, typed handles, and new batch methods.
  • Document BatchJobHandle, mixed durable continuation parents, multi-parent batches, continuation delays, and queue-aware recurring schedules.
  • Use the current handle names across the docs: JobHandle, BatchHandle, and the raw string Value property.
  • Document IConfiguration binding for worker, fair-queue, dashboard, and Redis options.
  • Update dashboard JSON fields, route parameters, monitoring records, telemetry examples, and structured log fields to use job and batch handles.
  • Update NodaTime, diagnostics, storage-provider, and execution-context guidance.
  • Replace the removed capture-only scheduler docs with CapturingJobStorage and the updated JobTestHarness API.

Source

Validation

  • pnpm check
  • pnpm lint
  • pnpm build
  • git diff --check

All checks pass. The production build reports the existing Vite chunk-size warning.

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0d1ae052-4c59-425f-a39d-4104cb87a3b1


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@viceroypenguin
viceroypenguin changed the base branch from docs/sync-immediate-jobs-2026-08-12 to main August 28, 2026 17:18
@viceroypenguin
viceroypenguin merged commit 85124ad into main Aug 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants