Skip to content

docs: add Quick Start example and update example timestamps in README#10

Merged
QuenumGerald merged 1 commit into
mainfrom
mettre-a-jour-le-readme
May 1, 2026
Merged

docs: add Quick Start example and update example timestamps in README#10
QuenumGerald merged 1 commit into
mainfrom
mettre-a-jour-le-readme

Conversation

@QuenumGerald

Copy link
Copy Markdown
Owner

Motivation

  • Provide an immediate "Quick start" snippet to help users bootstrap the scheduler with sqlite storage and basic usage.
  • Refresh example timestamps in the CLI and API examples to be current and reduce confusion from outdated dates.

Description

  • Add a new Quick start section with a minimal TypeScript example showing BlazeJob initialization, schedule, and start using storage: 'sqlite', dbPath, and concurrency options.
  • Update the npx ts-node src/bin/cli.ts schedule example timestamp to 2026-01-01T00:00:00Z and the curl runAt payload timestamp to 2026-01-01T00:00:00Z.
  • No application logic or tests were changed; this is documentation-only edits in README.md.

Testing

  • No automated tests were required or run because this change only updates documentation files.

Codex Task

@QuenumGerald QuenumGerald merged commit b1cc264 into main May 1, 2026
2 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ba1834da8e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
console.log("Job executed");
}, { runAt: new Date() });

await jobs.start();

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove top-level await from quick-start snippet

Using await jobs.start() at top level will fail for users following the repository’s default TypeScript/CommonJS setup, because top-level await is only allowed in ESM-compatible module configurations. A copy-paste of this “Quick start” example can therefore produce an immediate compile/runtime error instead of a working starter, while jobs.start() (without await) already matches the other README examples.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant