Interface RoutesAPI

What this sub-module offers.

interface RoutesAPI {
    saveRoute(entry: StoredRoute): Promise<void>;
    getRoute(id: string): Promise<StoredRoute | null>;
    listRoutes(): Promise<StoredRoute[]>;
    deleteRoute(id: string): Promise<void>;
}

Index

Methods

saveRoute getRoute listRoutes deleteRoute

Methods

saveRoute

saveRoute(entry: StoredRoute): Promise<void>
Writes a route, replacing any route with the same id.
Parameters
- entry: StoredRoute
  The route to persist.
Returns Promise<void>
Nothing. Rejects when the transaction fails.
- Defined in packages/core/src/capabilities/offline/db/routes.ts:72

getRoute

getRoute(id: string): Promise<StoredRoute | null>
Reads one route.
Parameters
- id: string
  Its identity.
Returns Promise<StoredRoute | null>
The route, or null when there is none.
- Defined in packages/core/src/capabilities/offline/db/routes.ts:79

listRoutes

listRoutes(): Promise<StoredRoute[]>
Every persisted route, newest first.

Returns Promise<StoredRoute[]>
The routes.
- Defined in packages/core/src/capabilities/offline/db/routes.ts:85

deleteRoute

deleteRoute(id: string): Promise<void>
Removes one route.
Parameters
- id: string
  Its identity.
Returns Promise<void>
Nothing. Resolves even when nothing was stored under id — a delete that reports "not found" makes callers write a read they do not need.
- Defined in packages/core/src/capabilities/offline/db/routes.ts:93