Class PolicyLoader

constructor

• new PolicyLoader(options: PolicyLoaderOptions): PolicyLoader

  Load policy bundles from Cerbos Hub.

  Parameters

  • options: PolicyLoaderOptions

  Returns PolicyLoader

  Example

  Unauthenticated access:

  const loader = new PolicyLoader({ ruleId: "B5LU9EVYN1MD" });
  Copy

  Example

  Authenticate with a client credential:

  import { credentialsFromEnv } from "@cerbos/hub";
  
  const loader = new PolicyLoader({
    ruleId: "B5LU9EVYN1MD",
    credentials: credentialsFromEnv(),
  });
  Copy

  Example

  Handle policy update errors:

  const loader = new PolicyLoader({
    ruleId: "B5LU9EVYN1MD",
    onUpdate: (error) => {
      if (error) {
        console.error("Cerbos policy update failed:", error);
      } else {
        console.info("Cerbos policies updated successfully");
      }
    },
  });
  Copy

ReadonlyruleId

Readonlyscopes

activate

• activate(): void

  Activate the pending policy bundle (if any).

  Returns void

  Remarks

  This is called automatically when a policy bundle update is downloaded, unless PolicyLoaderOptions.activateOnLoad is false.

stop

• stop(): void

  Stop polling for policy bundle updates.

  Returns void