Add docs

Author: TartanLlama

documentation/docs/experimental/setReusableSandboxOptions.mdx

@@ -0,0 +1,28 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# setReusableSandboxOptions
+
+The **`setReusableSandboxOptions()`** function configures the reuse of the same underlying sandbox for multiple requests, which can improve performance by avoiding the overhead of initializing a new sandbox for each request.
+
+## Syntax
+
+```js
+setReusableSandboxOptions(options)
+```
+
+### Parameters
+
+- `options` _: Object_
+  - The configuration options for the reusable sandbox.
+    - `maxRequests` _: number_ (default: `1`, `0` means unlimited)
+      - The maximum number of requests that can be handled by a single sandbox before it is recycled.
+    - `betweenRequestTimeoutMs` _: number_ (default: not specified)
+      - The amount of time in milliseconds to wait between requests before recycling the sandbox.
+    - `maxMemoryMiB` _: number_ (default: no limit)
+      - The maximum amount of memory in MiB that the sandbox can use before it is recycled.
+    - `sandboxTimeoutMs` _: number_ (default: no timeout)
+      - The maximum amount of time in milliseconds that a sandbox can be active before it is recycled.

integration-tests/js-compute/fixtures/app/src/index.js

@@ -4,7 +4,6 @@
 import { routes } from './routes.js';
 import { env } from 'fastly:env';
 import { enableDebugLogging } from 'fastly:experimental';
-import { setReusableSandboxOptions } from 'fastly:experimental';
 
 import './async-select.js';
 import './btoa.js';
@@ -57,13 +56,6 @@ import './tee.js';
 import './timers.js';
 import './urlsearchparams.js';
 
-setReusableSandboxOptions({
-        maxRequests: 10000, // Default is 1, 0 means unlimited
-        //betweenRequestTimeoutMs: 10000000, // 100ms, default is 0 (no timeout)
-        //maxMemoryMiB: 128, // 128MiB, default is 0 (no limit)
-        //sandboxTimeoutMs: 1, // 1000ms, default is 0 (no timeout) 
-});
-
 addEventListener('fetch', (event) => {
   event.respondWith(app(event));
 });

types/experimental.d.ts

@@ -84,4 +84,32 @@ declare module 'fastly:experimental' {
    * @param error
    */
   export function mapAndLogError(error: Error | string): void;
+
+  export interface ReusableSandboxOptions {
+    /**
+     * The maximum number of requests to handle with a single sandbox instance before it is recycled.
+     * Default is 1. A value of 0 means there is no maximum, and the sandbox may be reused indefinitely until it is recycled for another reason (e.g., timeout or memory limit).
+     */
+    maxRequests?: number;
+    /**
+     * The maximum amount of time in milliseconds to wait for the next request before recycling the sandbox. Default is up to the platform and not specified.
+     */
+    betweenRequestTimeoutMs?: number;
+    /**
+     * The maximum amount of memory in MiB that the sandbox is allowed to use. If the sandbox exceeds this limit, it will be recycled before handling the next request. Default is no limit.
+     */
+    maxMemoryMiB?: number;
+    /**
+     * The maximum amount of time in milliseconds that a sandbox is allowed to run before it is recycled after handling the current request. Default is no timeout.
+     */
+    sandboxTimeoutMs?: number;
+  }
+  /**
+   * Configure reuse of the same underlying sandbox for multiple requests, 
+   * which can improve performance by avoiding the overhead of initializing a 
+   * new sandbox for each request.
+   * @experimental
+   * @param options - Configuration options for sandbox reuse
+   */
+  export function setReusableSandboxOptions(options: ReusableSandboxOptions): void;
 }