Skip to content

Commit

Permalink
[miniflare] Update API docs for unsupported products
Browse files Browse the repository at this point in the history
  • Loading branch information
mrbbot committed Jan 17, 2024
1 parent 57bd776 commit a026e78
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions packages/miniflare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -519,10 +519,11 @@ parameter in module format Workers.

- `d1Databases?: Record<string, string> | string[]`

Record mapping binding name to D1 database IDs to inject as `Fetcher` bindings
into this Worker. Note these bindings must be wrapped with a facade to provide
the expected `D1Database` API. Different Workers may bind to the same database
ID with different binding names. If a `string[]` of binding names is
Record mapping binding name to D1 database IDs to inject as `D1Database`
bindings into this Worker. Note binding names starting with `__D1_BETA__` are
injected as `Fetcher` bindings instead, and must be wrapped with a facade to
provide the expected `D1Database` API. Different Workers may bind to the same
database ID with different binding names. If a `string[]` of binding names is
specified, the binding name and database ID are assumed to be the same.

#### Queues
Expand All @@ -541,10 +542,20 @@ parameter in module format Workers.
have at most one consumer. If a `string[]` of queue names is specified,
default consumer options will be used.

#### Analytics Engine
#### Analytics Engine, Sending Email, Vectorize and Workers for Platforms

_Not yet supported_

If you need support for these locally, consider using the `wrappedBindings`
option to mock them out.

#### Browser Rendering and Workers AI

_Not yet supported_

If you need support for these locally, consider using the `serviceBindings`
option to mock them out.

### `interface SharedOptions`

Options shared between all Workers/"nanoservices".
Expand Down Expand Up @@ -671,7 +682,7 @@ Options shared between all Workers/"nanoservices".

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

#### Analytics Engine
#### Analytics Engine, Browser Rendering, Sending Email, Vectorize, Workers AI and Workers for Platforms

_Not yet supported_

Expand Down

0 comments on commit a026e78

Please sign in to comment.