Dbos typescript
Guide for building reliable, fault-tolerant TypeScript applications with DBOS durable workflows. Use when adding DBOS to existing TypeScript code, creating workflows and steps, or using queues for concurrency control.From its SKILL.md
npx -y skills add sinhoneyy/master-skills --skill dbos-typescriptAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 17 stars17 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
3.2 KB, 682 tokens by cl100k_base, as published. Nobody here has run it
DBOS TypeScript Best Practices
Guide for building reliable, fault-tolerant TypeScript applications with DBOS durable workflows.
When to Use
Reference these guidelines when:
- Adding DBOS to existing TypeScript code
- Creating workflows and steps
- Using queues for concurrency control
- Implementing workflow communication (events, messages, streams)
- Configuring and launching DBOS applications
- Using DBOSClient from external applications
- Testing DBOS applications
Rule Categories by Priority
| Priority | Category | Impact | Prefix |
|---|---|---|---|
| 1 | Lifecycle | CRITICAL | lifecycle- |
| 2 | Workflow | CRITICAL | workflow- |
| 3 | Step | HIGH | step- |
| 4 | Queue | HIGH | queue- |
| 5 | Communication | MEDIUM | comm- |
| 6 | Pattern | MEDIUM | pattern- |
| 7 | Testing | LOW-MEDIUM | test- |
| 8 | Client | MEDIUM | client- |
| 9 | Advanced | LOW | advanced- |
Critical Rules
Installation
Always install the latest version of DBOS:
npm install @dbos-inc/dbos-sdk@latest
DBOS Configuration and Launch
A DBOS application MUST configure and launch DBOS before running any workflows:
import { DBOS } from "@dbos-inc/dbos-sdk";
async function main() {
DBOS.setConfig({
name: "my-app",
systemDatabaseUrl: process.env.DBOS_SYSTEM_DATABASE_URL,
});
await DBOS.launch();
await myWorkflow();
}
main().catch(console.log);
Workflow and Step Structure
Workflows are comprised of steps. Any function performing complex operations or accessing external services must be run as a step using DBOS.runStep:
import { DBOS } from "@dbos-inc/dbos-sdk";
async function fetchData() {
return await fetch("https://api.example.com").then(r => r.json());
}
async function myWorkflowFn() {
const result = await DBOS.runStep(fetchData, { name: "fetchData" });
return result;
}
const myWorkflow = DBOS.registerWorkflow(myWorkflowFn);
Key Constraints
- Do NOT call, start, or enqueue workflows from within steps
- Do NOT use threads or uncontrolled concurrency to start workflows - use
DBOS.startWorkflowor queues - Workflows MUST be deterministic - non-deterministic operations go in steps
- Do NOT modify global variables from workflows or steps
How to Use
Read individual rule files for detailed explanations and examples:
references/lifecycle-config.md
references/workflow-determinism.md
references/queue-concurrency.md
References
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
What ships with it: 34 files
62.4 KB alongside SKILL.md
references/
- advanced-patching.md2.0 KB
- advanced-versioning.md1.7 KB
- client-enqueue.md2.1 KB
- client-setup.md1.8 KB
- comm-events.md2.1 KB
- comm-messages.md1.9 KB
- comm-streaming.md1.9 KB
- lifecycle-config.md1.2 KB
- lifecycle-express.md1.5 KB
- pattern-classes.md2.0 KB
- pattern-debouncing.md1.9 KB
- pattern-idempotency.md1.9 KB
- pattern-scheduled.md2.2 KB
- pattern-sleep.md1.6 KB
- queue-basics.md1.6 KB
- queue-concurrency.md1.7 KB
- queue-deduplication.md1.6 KB
- queue-listening.md1.7 KB
- queue-partitioning.md1.9 KB
- queue-priority.md1.3 KB
- queue-rate-limiting.md1.2 KB
- _sections.md1.4 KB
- step-basics.md1.9 KB
- step-retries.md1.9 KB
- step-transactions.md2.2 KB
- test-setup.md3.0 KB
- workflow-background.md1.4 KB
- workflow-constraints.md1.9 KB
- workflow-control.md2.0 KB
- workflow-determinism.md1.6 KB
- workflow-introspection.md1.8 KB
- workflow-timeout.md1.3 KB