gtfs-sqljs
    Preparing search index...

    Interface GtfsSqlJsOptions

    interface GtfsSqlJsOptions {
        cache?: CacheStore | null;
        cacheExpirationMs?: number;
        cacheVersion?: string;
        database?: ArrayBuffer;
        locateFile?: (filename: string) => string;
        onProgress?: ProgressCallback;
        realtimeFeedUrls?: string[];
        skipFiles?: string[];
        SQL?: SqlJsStatic;
        stalenessThreshold?: number;
        zipPath?: string;
    }
    Index

    Properties

    cache? cacheExpirationMs? cacheVersion? database? locateFile? onProgress? realtimeFeedUrls? skipFiles? SQL? stalenessThreshold? zipPath?

    Properties

    cache?: CacheStore | null

    Optional: Cache store for persisting processed GTFS databases Implement your own CacheStore or copy one from examples/cache/:

    • IndexedDBCacheStore (browser)
    • FileSystemCacheStore (Node.js only)

    If not provided, caching is disabled.

    cacheExpirationMs?: number

    Optional: Cache expiration time in milliseconds Cached databases older than this will be invalidated Default: 7 days (604800000 ms)

    cacheVersion?: string

    Optional: Data version string When changed, cached databases are invalidated and reprocessed Default: '1.0'

    database?: ArrayBuffer

    Pre-loaded SQLite database as ArrayBuffer

    locateFile?: (filename: string) => string

    Optional: Path to SQL.js WASM file (for custom loading)

    onProgress?: ProgressCallback

    Optional: Progress callback for tracking load progress Useful for displaying progress in UI or web workers

    realtimeFeedUrls?: string[]

    Optional: Array of GTFS-RT feed URLs for realtime data

    skipFiles?: string[]

    Optional: Array of GTFS filenames to skip importing (e.g., ['shapes.txt']) Tables will be created but no data will be imported for these files

    SQL?: SqlJsStatic

    Optional: Custom SQL.js instance

    stalenessThreshold?: number

    Optional: Staleness threshold in seconds (default: 120) Realtime data older than this will be excluded from queries

    zipPath?: string

    Path or URL to GTFS ZIP file

    Settings

    Member Visibility

    On This Page

    Properties