@guard-sdk/core API

This spec is generated from package entry exports and updates on every website build.

Need package context first? Visit @guard-sdk/core package docs.

Exported Symbols

Kind	Name	Source
reexport	`guard`	./guard.js
reexport	`assertPreCallLimits`	./guard.js
reexport	`createGuardAbortSignal`	./guard.js
reexport	`createGuardStreamRun`	./guard.js
reexport	`validateGuardConfig`	./validate.js
type	`BudgetCommitOptions`	./types.js
type	`BudgetCommitResult`	./types.js
type	`BudgetSnapshot`	./types.js
type	`BudgetStore`	./types.js
type	`GuardBlockError`	./types.js
type	`GuardBudgetWindow`	./types.js
type	`GuardCallContext`	./types.js
type	`GuardConfig`	./types.js
type	`GuardHooks`	./types.js
type	`GuardLogger`	./types.js
type	`GuardMode`	./types.js
type	`GuardPolicyReason`	./types.js
type	`GuardResult`	./types.js
type	`GuardRun`	./types.js
type	`GuardStreamRun`	./types.js
type	`GuardStatus`	./types.js
type	`GuardUsage`	./types.js
type	`GuardWarning`	./types.js
type	`GuardWarningReason`	./types.js
reexport	`GuardError`	./errors.js
reexport	`GuardConfigError`	./errors.js
reexport	`BudgetExceededError`	./errors.js
reexport	`TokenLimitExceededError`	./errors.js
reexport	`CallLimitExceededError`	./errors.js
reexport	`TimeoutError`	./errors.js
reexport	`createConsoleLogger`	./loggers.js
reexport	`createJsonFileLogger`	./loggers.js
reexport	`createMemoryLogger`	./loggers.js
type	`JsonFileLoggerOptions`	./loggers.js
type	`MemoryLogger`	./loggers.js
reexport	`createTempDir`	./test-utils.js
reexport	`createTempDbPath`	./test-utils.js

Export Declarations

export { guard, assertPreCallLimits, createGuardAbortSignal, createGuardStreamRun, } from "./guard.js";
export { validateGuardConfig } from "./validate.js";
export type { BudgetCommitOptions, BudgetCommitResult, BudgetSnapshot, BudgetStore, GuardBlockError, GuardBudgetWindow, GuardCallContext, GuardConfig, GuardHooks, GuardLogger, GuardMode, GuardPolicyReason, GuardResult, GuardRun, GuardStreamRun, GuardStatus, GuardUsage, GuardWarning, GuardWarningReason, } from "./types.js";
export { GuardError, GuardConfigError, BudgetExceededError, TokenLimitExceededError, CallLimitExceededError, TimeoutError, } from "./errors.js";
export { createConsoleLogger, createJsonFileLogger, createMemoryLogger } from "./loggers.js";
export type { JsonFileLoggerOptions, MemoryLogger } from "./loggers.js";
export { createTempDir, createTempDbPath } from "./test-utils.js";

JSON Spec

{
  "package": "@guard-sdk/core",
  "version": "0.6.0",
  "exports": [
    {
      "kind": "reexport",
      "name": "guard",
      "source": "./guard.js"
    },
    {
      "kind": "reexport",
      "name": "assertPreCallLimits",
      "source": "./guard.js"
    },
    {
      "kind": "reexport",
      "name": "createGuardAbortSignal",
      "source": "./guard.js"
    },
    {
      "kind": "reexport",
      "name": "createGuardStreamRun",
      "source": "./guard.js"
    },
    {
      "kind": "reexport",
      "name": "validateGuardConfig",
      "source": "./validate.js"
    },
    {
      "kind": "type",
      "name": "BudgetCommitOptions",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "BudgetCommitResult",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "BudgetSnapshot",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "BudgetStore",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardBlockError",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardBudgetWindow",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardCallContext",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardConfig",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardHooks",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardLogger",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardMode",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardPolicyReason",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardResult",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardRun",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardStreamRun",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardStatus",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardUsage",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardWarning",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardWarningReason",
      "source": "./types.js"
    },
    {
      "kind": "reexport",
      "name": "GuardError",
      "source": "./errors.js"
    },
    {
      "kind": "reexport",
      "name": "GuardConfigError",
      "source": "./errors.js"
    },
    {
      "kind": "reexport",
      "name": "BudgetExceededError",
      "source": "./errors.js"
    },
    {
      "kind": "reexport",
      "name": "TokenLimitExceededError",
      "source": "./errors.js"
    },
    {
      "kind": "reexport",
      "name": "CallLimitExceededError",
      "source": "./errors.js"
    },
    {
      "kind": "reexport",
      "name": "TimeoutError",
      "source": "./errors.js"
    },
    {
      "kind": "reexport",
      "name": "createConsoleLogger",
      "source": "./loggers.js"
    },
    {
      "kind": "reexport",
      "name": "createJsonFileLogger",
      "source": "./loggers.js"
    },
    {
      "kind": "reexport",
      "name": "createMemoryLogger",
      "source": "./loggers.js"
    },
    {
      "kind": "type",
      "name": "JsonFileLoggerOptions",
      "source": "./loggers.js"
    },
    {
      "kind": "type",
      "name": "MemoryLogger",
      "source": "./loggers.js"
    },
    {
      "kind": "reexport",
      "name": "createTempDir",
      "source": "./test-utils.js"
    },
    {
      "kind": "reexport",
      "name": "createTempDbPath",
      "source": "./test-utils.js"
    }
  ]
}