@sveltejs/adapter-cloudflare-workers - npm Package Compare versions

Comparing version 1.0.0-next.47 to 1.0.0-next.48

package.json

 {
   "name": "@sveltejs/adapter-cloudflare-workers",
-  "version": "1.0.0-next.47",
+  "version": "1.0.0-next.48",
   "repository": {
@@ -26,2 +26,3 @@ "type": "git",
   "dependencies": {
+    "@cloudflare/workers-types": "^3.14.0",
     "@iarna/toml": "^2.2.5",
@@ -28,0 +29,0 @@ "esbuild": "^0.14.42"

README.md

@@ -72,4 +72,32 @@ # adapter-cloudflare-workers
 
+## Environment variables
+
+The [`env`](https://developers.cloudflare.com/workers/runtime-apis/fetch-event#parameters) object, containing KV/DO namespaces etc, is passed to SvelteKit via the `platform` property along with `context` and `caches`, meaning you can access it in hooks and endpoints:
+
+```js
+export async function post({ request, platform }) {
+  const x = platform.env.YOUR_DURABLE_OBJECT_NAMESPACE.idFromName('x');
+}
+```
+
+To make these types available to your app, reference them in your `src/app.d.ts`:
+
+```diff
+/// <reference types="@sveltejs/kit" />
++/// <reference types="@sveltejs/adapter-cloudflare-workers" />
+
+declare namespace App {
+	interface Platform {
++		env?: {
++			YOUR_KV_NAMESPACE: KVNamespace;
++			YOUR_DURABLE_OBJECT_NAMESPACE: DurableObjectNamespace;
++		};
+	}
+}
+```
+
+> `platform.env` is only available in the production build. Use [wrangler](https://developers.cloudflare.com/workers/cli-wrangler) to test it locally
+
 ## Changelog
 
 [The Changelog for this package is available on GitHub](https://github.com/sveltejs/kit/blob/master/packages/adapter-cloudflare-workers/CHANGELOG.md).

No alert changes

Improved metrics

Total package byte prevSize

11948

increased by9.04%

Number of lines in readme file

103

increased by37.33%

Worsened metrics

Dependency count

3

increased by50%

Dependency changes

• + Added@cloudflare/workers-types@^3.14.0

• + Added@cloudflare/workers-types@3.19.0(transitive)