docs: add Quick Start example and update example timestamps in README#10
Conversation
There was a problem hiding this comment.
💡 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".
| console.log("Job executed"); | ||
| }, { runAt: new Date() }); | ||
|
|
||
| await jobs.start(); |
There was a problem hiding this comment.
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 👍 / 👎.
Motivation
sqlitestorage and basic usage.Description
Quick startsection with a minimal TypeScript example showingBlazeJobinitialization,schedule, andstartusingstorage: 'sqlite',dbPath, andconcurrencyoptions.npx ts-node src/bin/cli.ts scheduleexample timestamp to2026-01-01T00:00:00Zand thecurlrunAtpayload timestamp to2026-01-01T00:00:00Z.README.md.Testing
Codex Task