fgb-vt - v1.0.6
    Preparing search index...

    Interface IoOptions

    I/O options for reading FlatGeobuf sources.

    Accepted wherever tiling options are (tile(), TileClient, TileServer) and applied to every source of the call or instance.

    interface IoOptions {
        cache?: false | ByteCache;
        coalesceGap?: number;
        maxFeatureBytes?: number;
        maxScanBytes?: number;
        prefetch?: number;
    }
    Index
    cache?: false | ByteCache

    Cache for file headers and spatial index pages.

    By default tile() shares one module-level MemoryCache (so warm serverless containers reuse it) and every TileClient / TileServer gets its own. Pass a custom ByteCache to size or back it differently, or false to read everything per request.

    Entries are keyed by source path and version tag. With connectors that report no version tag, files must not change while cached.

    coalesceGap?: number

    Byte ranges separated by at most this many bytes are merged into one read. Defaults to the connector's hint (4 KiB local, 64 KiB HTTP/S3).

    maxFeatureBytes?: number

    Largest single feature (in bytes) that will be read. Guards against corrupt size prefixes triggering huge reads; larger features raise LimitExceededError.

    268435456 (256 MiB)
    
    maxScanBytes?: number

    Largest feature section (in bytes) that may be scanned sequentially for a file without a spatial index; larger files raise LimitExceededError.

    33554432 (32 MiB)
    
    prefetch?: number

    Size of the first read of each file, covering the header and the top of the spatial index. Defaults to the connector's hint (64 KiB local, 256 KiB HTTP/S3 in Node.js, 16 KiB HTTP in browsers).