Class GtfsSqlJs

Methods

buildGraph

buildGraph(tripIds: string[]): Promise<Graph>
Build a directed stop-to-stop graph for the given trips.

Edges connect consecutive stops in a trip (paired via stop_sequence, whose values need not be contiguous). Each edge carries the list of trips traversing it, with route_id and direction_id attached.
Parameters
- tripIds: string[]
Returns Promise<Graph>
- Defined in src/gtfs-sqljs.ts:777

buildOrderedStopList

buildOrderedStopList(tripIds: string[]): Promise<Stop[]>
Build an ordered list of stops from multiple trips
Parameters
- tripIds: string[]
Returns Promise<Stop[]>
- Defined in src/gtfs-sqljs.ts:765

clearRealtimeData

clearRealtimeData(): Promise<void>
Clear all realtime data from the database

Returns Promise<void>
- Defined in src/gtfs-sqljs.ts:847

close

close(): Promise<void>
Close the database connection.

When the library itself created the DB handle (via fromZip, fromZipData, fromDatabase, or when attach() was called with ownsDatabase: true), this also closes the underlying adapter. For handles passed to attach() without ownsDatabase, this is a no-op beyond clearing the internal reference — the caller owns the handle.

Returns Promise<void>
- Defined in src/gtfs-sqljs.ts:619

debugExportAllAlerts

debugExportAllAlerts(): Promise<Alert[]>
Returns Promise<Alert[]>
- Defined in src/gtfs-sqljs.ts:886

debugExportAllStopTimeUpdates

debugExportAllStopTimeUpdates(): Promise<StopTimeUpdate[]>
Returns Promise<StopTimeUpdate[]>
- Defined in src/gtfs-sqljs.ts:901

debugExportAllTripUpdates

debugExportAllTripUpdates(): Promise<TripUpdate[]>
Returns Promise<TripUpdate[]>
- Defined in src/gtfs-sqljs.ts:896

debugExportAllVehiclePositions

debugExportAllVehiclePositions(): Promise<VehiclePosition[]>
Returns Promise<VehiclePosition[]>
- Defined in src/gtfs-sqljs.ts:891

export

export(): Promise<ArrayBuffer>
Export database to ArrayBuffer

Throws ExportNotSupportedError if the active adapter is file-backed and cannot serialize the database to bytes.

Returns Promise<ArrayBuffer>
- Defined in src/gtfs-sqljs.ts:598

fetchRealtimeData

fetchRealtimeData(urls?: string[]): Promise<void>
Fetch and load GTFS Realtime data from configured feed URLs or provided URLs
Parameters
- Optionalurls: string[]
Returns Promise<void>
- Defined in src/gtfs-sqljs.ts:822

getActiveServiceIds

getActiveServiceIds(date: string): Promise<string[]>
Get active service IDs for a given date (YYYYMMDD format)
Parameters
- date: string
Returns Promise<string[]>
- Defined in src/gtfs-sqljs.ts:674

getAgencies

getAgencies(filters?: AgencyFilters): Promise<Agency[]>
Get agencies with optional filters Pass agencyId filter to get a specific agency
Parameters
- Optionalfilters: AgencyFilters
Returns Promise<Agency[]>
- Defined in src/gtfs-sqljs.ts:642

getAlerts

getAlerts(filters?: AlertFilters): Promise<Alert[]>
Get alerts with optional filters
Parameters
- Optionalfilters: AlertFilters
Returns Promise<Alert[]>
- Defined in src/gtfs-sqljs.ts:855

getCalendarByServiceId

getCalendarByServiceId(serviceId: string): Promise<Calendar | null>
Get calendar entry by service_id
Parameters
- serviceId: string
Returns Promise<Calendar | null>
- Defined in src/gtfs-sqljs.ts:682

getCalendarDates

getCalendarDates(serviceId: string): Promise<CalendarDate[]>
Get calendar date exceptions for a service
Parameters
- serviceId: string
Returns Promise<CalendarDate[]>
- Defined in src/gtfs-sqljs.ts:690

getCalendarDatesForDate

getCalendarDatesForDate(date: string): Promise<CalendarDate[]>
Get calendar date exceptions for a specific date
Parameters
- date: string
Returns Promise<CalendarDate[]>
- Defined in src/gtfs-sqljs.ts:698

getDatabase

getDatabase(): GtfsDatabase
Get direct access to the underlying adapter database handle (for advanced queries).

Returns GtfsDatabase
- Defined in src/gtfs-sqljs.ts:629

getLastRealtimeFetchTimestamp

getLastRealtimeFetchTimestamp(): number | null
Get timestamp of the last successful realtime data fetch and insertion

Returns number | null
- Defined in src/gtfs-sqljs.ts:815

getRealtimeFeedUrls

getRealtimeFeedUrls(): string[]
Get currently configured GTFS-RT feed URLs

Returns string[]
- Defined in src/gtfs-sqljs.ts:794

getRoutes

getRoutes(filters?: RouteFilters): Promise<Route[]>
Get routes with optional filters Pass routeId filter to get a specific route
Parameters
- Optionalfilters: RouteFilters
Returns Promise<Route[]>
- Defined in src/gtfs-sqljs.ts:664

getShapes

getShapes(filters?: ShapeFilters): Promise<Shape[]>
Get shapes with optional filters
Parameters
- Optionalfilters: ShapeFilters
Returns Promise<Shape[]>
- Defined in src/gtfs-sqljs.ts:729

getShapesToGeojson

getShapesToGeojson(
filters?: ShapeFilters,
precision?: number,
): Promise<GeoJsonFeatureCollection>
Get shapes as GeoJSON FeatureCollection
Parameters
- Optionalfilters: ShapeFilters
- precision: number = 6
Returns Promise<GeoJsonFeatureCollection>
- Defined in src/gtfs-sqljs.ts:737

getStalenessThreshold

getStalenessThreshold(): number
Get current staleness threshold

Returns number
- Defined in src/gtfs-sqljs.ts:808

getStops

getStops(filters?: StopFilters): Promise<Stop[]>
Get stops with optional filters Pass stopId filter to get a specific stop
Parameters
- Optionalfilters: StopFilters
Returns Promise<Stop[]>
- Defined in src/gtfs-sqljs.ts:653

getStopTimes

getStopTimes(filters?: StopTimeFilters & { date?: string }): Promise<StopTime[]>
Get stop times with optional filters
Parameters
- Optionalfilters: StopTimeFilters & { date?: string }
Returns Promise<StopTime[]>
- Defined in src/gtfs-sqljs.ts:747

getStopTimeUpdates

getStopTimeUpdates(filters?: StopTimeUpdateFilters): Promise<StopTimeUpdate[]>
Get stop time updates with optional filters
Parameters
- Optionalfilters: StopTimeUpdateFilters
Returns Promise<StopTimeUpdate[]>
- Defined in src/gtfs-sqljs.ts:879

getTrips

getTrips(filters?: TripFilters & { date?: string }): Promise<Trip[]>
Get trips with optional filters Pass tripId filter to get a specific trip
Parameters
- Optionalfilters: TripFilters & { date?: string }
Returns Promise<Trip[]>
- Defined in src/gtfs-sqljs.ts:709

getTripUpdates

getTripUpdates(filters?: TripUpdateFilters): Promise<TripUpdate[]>
Get trip updates with optional filters
Parameters
- Optionalfilters: TripUpdateFilters
Returns Promise<TripUpdate[]>
- Defined in src/gtfs-sqljs.ts:871

getVehiclePositions

getVehiclePositions(
filters?: VehiclePositionFilters,
): Promise<VehiclePosition[]>
Get vehicle positions with optional filters
Parameters
- Optionalfilters: VehiclePositionFilters
Returns Promise<VehiclePosition[]>
- Defined in src/gtfs-sqljs.ts:863

loadRealtimeDataFromBuffers

loadRealtimeDataFromBuffers(
buffers: Uint8Array<ArrayBufferLike>[],
): Promise<void>
Load GTFS Realtime data from pre-loaded protobuf buffers
Parameters
- buffers: Uint8Array<ArrayBufferLike>[]
Returns Promise<void>
- Defined in src/gtfs-sqljs.ts:837

setRealtimeFeedUrls

setRealtimeFeedUrls(urls: string[]): void
Set GTFS-RT feed URLs
Parameters
- urls: string[]
Returns void
- Defined in src/gtfs-sqljs.ts:787

setStalenessThreshold

setStalenessThreshold(seconds: number): void
Set staleness threshold in seconds
Parameters
- seconds: number
Returns void
- Defined in src/gtfs-sqljs.ts:801

`Static`attach

attach(db: GtfsDatabase, options?: GtfsSqlJsAttachOptions): Promise<GtfsSqlJs>
Attach to a pre-opened database handle.

Use this path when the caller already owns a live GtfsDatabase (typical for file-backed native drivers: op-sqlite, expo-sqlite, better-sqlite3). No adapter factory is needed — the handle is the adapter output.
Parameters
- db: GtfsDatabase
- options: GtfsSqlJsAttachOptions = {}
Returns Promise<GtfsSqlJs>
- Defined in src/gtfs-sqljs.ts:232

`Static`cleanExpiredCache

cleanExpiredCache(
cacheStore: CacheStore,
expirationMs?: number,
): Promise<number>
Parameters
- cacheStore: CacheStore
- expirationMs: number = DEFAULT_CACHE_EXPIRATION_MS
Returns Promise<number>
- Defined in src/gtfs-sqljs.ts:919

`Static`clearCache

clearCache(cacheStore: CacheStore): Promise<void>
Parameters
- cacheStore: CacheStore
Returns Promise<void>
- Defined in src/gtfs-sqljs.ts:939

`Static`fromDatabase

fromDatabase(database: ArrayBuffer, options: FactoryOptions): Promise<GtfsSqlJs>
Create GtfsSqlJs instance from existing SQLite database
Parameters
- database: ArrayBuffer
- options: FactoryOptions
Returns Promise<GtfsSqlJs>
- Defined in src/gtfs-sqljs.ts:214

`Static`fromZip

fromZip(zipPath: string, options: FactoryOptions): Promise<GtfsSqlJs>
Create GtfsSqlJs instance from GTFS ZIP file path or URL
Parameters
- zipPath: string
- options: FactoryOptions
Returns Promise<GtfsSqlJs>
- Defined in src/gtfs-sqljs.ts:187

`Static`fromZipData

fromZipData(
    zipData: ArrayBuffer | Uint8Array<ArrayBufferLike>,
    options: FactoryOptions,
    source?: string,
): Promise<GtfsSqlJs>
Create GtfsSqlJs instance from pre-loaded GTFS ZIP data
Parameters
- zipData: ArrayBuffer | Uint8Array<ArrayBufferLike>
- options: FactoryOptions
- Optionalsource: string
  Optional original path/URL, used for cache key generation and metadata
Returns Promise<GtfsSqlJs>
- Defined in src/gtfs-sqljs.ts:200

`Static`getCacheStats

getCacheStats(
    cacheStore: CacheStore,
): Promise<
    {
        activeEntries: number;
        expiredEntries: number;
        newestEntry: number
        | null;
        oldestEntry: number | null;
        totalEntries: number;
        totalSize: number;
        totalSizeMB: string;
    },
>
Parameters
- cacheStore: CacheStore
Returns Promise<
    {
        activeEntries: number;
        expiredEntries: number;
        newestEntry: number
        | null;
        oldestEntry: number | null;
        totalEntries: number;
        totalSize: number;
        totalSizeMB: string;
    },
>
- Defined in src/gtfs-sqljs.ts:908

`Static`listCache

listCache(
cacheStore: CacheStore,
includeExpired?: boolean,
): Promise<CacheEntry[]>
Parameters
- cacheStore: CacheStore
- includeExpired: boolean = false
Returns Promise<CacheEntry[]>
- Defined in src/gtfs-sqljs.ts:947

Class GtfsSqlJs

Index

Methods

Methods

buildGraph

Parameters

Returns Promise<Graph>

buildOrderedStopList

Parameters

Returns Promise<Stop[]>

clearRealtimeData

Returns Promise<void>

close

Returns Promise<void>

debugExportAllAlerts

Returns Promise<Alert[]>

debugExportAllStopTimeUpdates

Returns Promise<StopTimeUpdate[]>

debugExportAllTripUpdates

Returns Promise<TripUpdate[]>

debugExportAllVehiclePositions

Returns Promise<VehiclePosition[]>

export

Returns Promise<ArrayBuffer>

fetchRealtimeData

Parameters

Returns Promise<void>

getActiveServiceIds

Parameters

Returns Promise<string[]>

getAgencies

Parameters

Returns Promise<Agency[]>

getAlerts

Parameters

Returns Promise<Alert[]>

getCalendarByServiceId

Parameters

Returns Promise<Calendar | null>

getCalendarDates

Parameters

Returns Promise<CalendarDate[]>

getCalendarDatesForDate

Parameters

Returns Promise<CalendarDate[]>

getDatabase

Returns GtfsDatabase

getLastRealtimeFetchTimestamp

Returns number | null

getRealtimeFeedUrls

Returns string[]

getRoutes

Parameters

Returns Promise<Route[]>

getShapes

Parameters

Returns Promise<Shape[]>

getShapesToGeojson

Parameters

Returns Promise<GeoJsonFeatureCollection>

getStalenessThreshold

Returns number

getStops

Parameters

Returns Promise<Stop[]>

getStopTimes

Parameters

Returns Promise<StopTime[]>

getStopTimeUpdates

Parameters

Returns Promise<StopTimeUpdate[]>

getTrips

Parameters

Returns Promise<Trip[]>

getTripUpdates

Parameters

Returns Promise<TripUpdate[]>

getVehiclePositions

Parameters

Returns Promise<VehiclePosition[]>

`Static`attach

`Static`cleanExpiredCache

`Static`clearCache

`Static`fromDatabase

`Static`fromZip

`Static`fromZipData

`Static`getCacheStats

Returns Promise<
{
activeEntries: number;
expiredEntries: number;
newestEntry: number
| null;
oldestEntry: number | null;
totalEntries: number;
totalSize: number;
totalSizeMB: string;
},
>

`Static`listCache