# Cloudflare durable-object

Add a Durable Object class, binding, and migration


## When to use it

Add a Durable Object class, binding, and migration. Use this when you want to add the corresponding files or task to your workspace.

## Usage

```sh
npm exec -- nx generate @megamono/nx-cloudflare:durable-object --project="<project>" --className="<className>" --dry-run
```

Replace angle-bracket placeholders with reviewed values. Nx's `--dry-run` previews generator writes; remove it only after reviewing the plan. Examples use npm; use your workspace's package manager if it differs.

## Options

Use these options with `@megamono/nx-cloudflare:durable-object`. Nx uses the camelCase names shown here; the [CLI reference](/docs/cli) describes command-line aliases. Some options are required only for particular choices.

| Option | Required | Type | Default | Description |
| --- | --- | --- | --- | --- |
| `project` | Yes | string | — | Existing Nx Worker project name. |
| `className` | Yes | string | — | Durable Object class name. |
| `binding` | No | string | — | Worker-visible binding name; defaults from the class name. |
| `migrationTag` | No | string | "v1" | Unique Wrangler migration tag. |
| `configPath` | No | string | — | Explicit Wrangler config when the project contains more than one. |
| `dryRun` | No | boolean | false | Print the deterministic plan without mutation. |

## Next steps

Review changed files and run the affected project's checks. For options that accept structured values, run the generator's `--help` or consult the schema in the installed package.

- [All generators](/docs/generators)
- [CLI overview](/docs/cli)
- [Adopt an existing workspace](/docs/workflows/adoption)