@guard-sdk/storage-sqlite API

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

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

Exported Symbols

Kind Name Source
type SQLiteLoggerOptions entry
type SQLiteLogger entry
type UsageReportFilters entry
type ReadUsageReportOptions entry
type UsageReportSummary entry
function createSQLiteLogger entry
type SQLiteBudgetStoreOptions entry
type SQLiteBudgetStore entry
function createSQLiteBudgetStore entry
function readUsageReport entry

Export Declarations

export type SQLiteLoggerOptions = { dbPath: string;
export type SQLiteLogger = GuardLogger & { close: () => void;
export type UsageReportFilters = { from?: string;
export type ReadUsageReportOptions = { dbPath: string;
export type UsageReportSummary = { totalRuns: number;
export declare function createSQLiteLogger(options: SQLiteLoggerOptions): Promise<SQLiteLogger>;
export type SQLiteBudgetStoreOptions = { dbPath: string;
export type SQLiteBudgetStore = { get: (key: string) => BudgetSnapshot;
export declare function createSQLiteBudgetStore(options: SQLiteBudgetStoreOptions): Promise<SQLiteBudgetStore>;
export declare function readUsageReport(options: ReadUsageReportOptions): UsageReportSummary;

JSON Spec

{
  "package": "@guard-sdk/storage-sqlite",
  "version": "0.6.0",
  "exports": [
    {
      "kind": "type",
      "name": "SQLiteLoggerOptions",
      "source": null
    },
    {
      "kind": "type",
      "name": "SQLiteLogger",
      "source": null
    },
    {
      "kind": "type",
      "name": "UsageReportFilters",
      "source": null
    },
    {
      "kind": "type",
      "name": "ReadUsageReportOptions",
      "source": null
    },
    {
      "kind": "type",
      "name": "UsageReportSummary",
      "source": null
    },
    {
      "kind": "function",
      "name": "createSQLiteLogger",
      "source": null
    },
    {
      "kind": "type",
      "name": "SQLiteBudgetStoreOptions",
      "source": null
    },
    {
      "kind": "type",
      "name": "SQLiteBudgetStore",
      "source": null
    },
    {
      "kind": "function",
      "name": "createSQLiteBudgetStore",
      "source": null
    },
    {
      "kind": "function",
      "name": "readUsageReport",
      "source": null
    }
  ]
}