Documentation Map¶

Use this page to decide where to go next based on the way you plan to use NCronJob.

Start here¶

• Getting Started for the first working setup
• Define and Schedule Jobs for recurring jobs
• Minimal API for delegate-based jobs

Common user journeys¶

I want a recurring background job¶

1. Getting Started
2. Define and Schedule Jobs
3. Passing Parameters
4. Concurrency control
5. Job timeouts and run expiry

I want to trigger work from an HTTP endpoint or application code¶

1. Triggering instant jobs
2. Passing Parameters
3. Notifications
4. Dynamic Job Control

I want orchestration between jobs¶

1. Model Dependencies
2. Conditional Job Scheduling
3. Notifications

I want to change jobs at runtime¶

1. Dynamic Job Control
2. Define and Schedule Jobs
3. Known gotchas

Sample applications¶

The repository contains three useful starting points:

• sample/MinimalSample: smallest recurring job setup
• sample/NCronJobSample: typed jobs, retries, concurrency, notifications, and HTTP-triggered instant jobs
• sample/RunOnceSample: startup jobs via RunAtStartup(...) and UseNCronJobAsync()

Important concepts to keep in mind¶

• Jobs run in-process and are not persisted across restarts
• Parameters are passed by reference and are not serialized
• Named jobs are the best choice when you want runtime management or to avoid ambiguity
• Forced instant jobs bypass queue and concurrency safeguards
• Startup jobs need UseNCronJobAsync() or UseNCronJob()

Human docs vs. agent docs¶

Most pages in this site are written for human readers.

If you are consuming the docs with an agent or want a compact machine-friendly entry point, use:

• Agent & Automation Guide
• llms.txt
• Compact Markdown Reference