Class Loader

Loads an embedded policy decision point bundle from a given source.

Hierarchy (View Summary)

Loader
- AutoUpdatingLoader

Index

Constructors

Methods

Constructors

constructor

new Loader(source: Source, options?: Options): Loader
Load an embedded policy decision point (PDP) bundle from a given source.
Parameters
- source: Source
  WebAssembly binary code of an embedded PDP bundle, or a URL or HTTP response from which to stream it.
- options: Options = {}
  Additional settings.
Returns Loader
Remarks
Bundle download URLs are available in the "Embedded" section of the "Decision points" page of your Cerbos Hub workspace.

The bundle will be loaded in the background when the loader is created. If loading fails, then the first request from the client using the loader will throw an error. To detect failure to load the bundle before making any requests, provide an Options.onError callback or await the Loader.active method.
Example
Fetch an embedded PDP bundle via HTTP in a supported browser or Node.js:
```
const loader = new Loader("https://lite.cerbos.cloud/bundle?workspace=...&label=...");
```
Example
Read an embedded PDP bundle from disk in Node.js:
```
import { readFile } from "fs/promises";

const loader = new Loader(readFile("policies.wasm"));
```
Example
Load an embedded PDP bundle from a precompiled WebAssembly module (requires a bundler):
```
import bundle from "bundle.wasm";

const loader = new Loader(bundle);
```
- Defined in packages/embedded/src/loader.ts:290

Methods

active

active(): Promise<BundleMetadata>
Resolves to the metadata of the loaded bundle, or rejects with the error that was encountered when loading the bundle.

Returns Promise<BundleMetadata>
- Defined in packages/embedded/src/loader.ts:304