@fastly/js-compute

@fastly/js-compute

JavaScript SDK and CLI for building JavaScript applications on Fastly's Compute@Edge.

Getting Started

We recommend using the Fastly CLI to create, build, and deploy JavaScript Compute@Edge services, as described on the Fastly Developer Hub.

Detailed documentation for JavaScript Compute@Edge services is also available on Fastly Developer Hub.

Usage

JavaScript Examples

The Fastly Developer Hub has a collection of example JavaScript applications.

Here is a small example application:

/// <reference types="@fastly/js-compute" />

async function app(event) {
    const request = event.request;
    return new Response(`You made a request to ${request.url}`)
}

addEventListener("fetch", event => {
  event.respondWith(app(event));
});

API documentation

The API documentation for the JavaScript SDK is located at https://js-compute-reference-docs.edgecompute.app.

Security

If you find any security issues, see the Fastly Security Reporting Page or send an email to: [e-mail]

We plan to disclose any found security vulnerabilities per the GitHub security vulnerability guidance. Note that communications related to security issues in Fastly-maintained OSS as described here are distinct from Fastly security advisories.

Changelog

The changelog can be found here.

License

Apache-2.0 WITH LLVM-exception

Changelog

2.0.0 (2023-05-15)

Changed

• Object Store renamed to KV Store (#476)

We have renamed the ObjectStore class to KVStore, and the module name from fastly:object-store to fastly:kv-store.

You will need to update your code to use the new class name and module name.

Below is the change that would need to be made for the imported module name:

- import { ObjectStore } from 'fastly:object-store';
+ import { KVStore } from 'fastly:kv-store';

And this is the change that would need to be made for constructing an instance of the class:

- const store = new ObjectStore('my-store');
+ const store = new KVStore('my-store');

Here is a full example of migrating an application from ObjectStore to KVStore:

/// <reference types="@fastly/js-compute" />

- import { ObjectStore } from 'fastly:object-store';
+ import { KVStore } from 'fastly:kv-store';

async function app(event) {
-   const files = new ObjectStore('files');
+   const files = new KVStore('files');

  await files.put('hello', 'world')

  const entry = await files.get('hello')

  return new Response(await entry.text())
}

addEventListener("fetch", (event) => event.respondWith(app(event)))