@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
type GuardConfig ./types.js
type GuardLogger ./types.js
type GuardMode ./types.js
type GuardPolicyReason ./types.js
type GuardResult ./types.js
type GuardRun ./types.js
type GuardStatus ./types.js
type GuardUsage ./types.js
reexport GuardError ./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

Export Declarations

export { guard } from "./guard.js";
export type { GuardConfig, GuardLogger, GuardMode, GuardPolicyReason, GuardResult, GuardRun, GuardStatus, GuardUsage, } from "./types.js";
export { GuardError, BudgetExceededError, TokenLimitExceededError, CallLimitExceededError, TimeoutError, } from "./errors.js";
export { createConsoleLogger, createJsonFileLogger, createMemoryLogger } from "./loggers.js";
export type { JsonFileLoggerOptions, MemoryLogger } from "./loggers.js";

JSON Spec

{
  "package": "@guard-sdk/core",
  "version": "0.5.0",
  "exports": [
    {
      "kind": "reexport",
      "name": "guard",
      "source": "./guard.js"
    },
    {
      "kind": "type",
      "name": "GuardConfig",
      "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": "GuardStatus",
      "source": "./types.js"
    },
    {
      "kind": "type",
      "name": "GuardUsage",
      "source": "./types.js"
    },
    {
      "kind": "reexport",
      "name": "GuardError",
      "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"
    }
  ]
}