Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Miniflare 3] Minor API docs fixes #621

Merged
merged 3 commits into from
Jun 30, 2023
Merged

[Miniflare 3] Minor API docs fixes #621

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f81cc90
Remove `--experimental-local` flag from `wrangler dev` in docs
mrbbot Jun 30, 2023
08d7ebf
Mark `durableObjectsPersist` as supported in docs
mrbbot Jun 30, 2023
cf942ef
Remove Queues from `SharedOptions` in docs
mrbbot Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 3 additions & 5 deletions packages/miniflare/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
[`workerd`](https://github.com/cloudflare/workerd).

> :warning: Miniflare 3 is API-only, and does not expose a CLI. Use Wrangler
> with `wrangler dev --experimental-local` to develop your Workers locally with
> Miniflare 3.
> with `wrangler dev` to develop your Workers locally with Miniflare 3.

## Quick Start

Expand Down Expand Up @@ -523,8 +522,7 @@ Options shared between all Workers/"nanoservices".

- `durableObjectsPersist?: Persistence`

_Not yet supported_, Miniflare will throw if this is truthy and Durable Object
bindings are specified.
Where to persist data stored in Durable Objects. See docs for `Persistence`.

- `kvPersist?: Persistence`

Expand All @@ -538,7 +536,7 @@ Options shared between all Workers/"nanoservices".

Where to persist data stored in D1 databases. See docs for `Persistence`.

#### Analytics Engine and Queues
#### Analytics Engine

_Not yet supported_

Expand Down