KnowledgeOS API Reference
    Preparing search index...

    Interface PersistenceBackend

    interface PersistenceBackend {
        appendEvent(event: PersistedEvent): Promise<AppendEventResult>;
        clear(): Promise<ClearResult>;
        close(): Promise<CloseResult>;
        getCapabilities(): BackendCapabilities;
        getLifecycleState(): BackendLifecycleState;
        health(): Promise<BackendHealth>;
        init(config: BackendConfig): Promise<InitResult>;
        load(): Promise<LoadResult>;
        loadEvents(): Promise<LoadEventsResult>;
        save(snapshot: PersistenceSnapshot): Promise<SaveResult>;
    }

    Implemented by

    Index
    appendEvent clear close getCapabilities getLifecycleState health init load loadEvents save

    • Remove all persisted data (snapshot + events)

      Returns Promise<ClearResult>

    • Disconnect and release resources

      Returns Promise<CloseResult>

    • Report backend health status (non-blocking)

      Returns Promise<BackendHealth>

    • Retrieve the persisted snapshot (or null if none)

      Returns Promise<LoadResult>

    • Retrieve all persisted events in insertion order

      Returns Promise<LoadEventsResult>

    Settings
    Member Visibility

    On This Page
    Methods