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

    Interface CheckReport

    Result of checkFile.

    interface CheckReport {
        etag: string | null;
        features:
            | {
                bbox: BBox
                | null;
                bytes: number;
                checked: number;
                complete: boolean;
                withoutGeometry: number;
            }
            | null;
        header: | {
            columns: { name: string; type: string }[];
            crs: string | null;
            crsSupport: "lonlat" | "webmercator" | "needs-projection";
            description: string | null;
            envelope: BBox | null;
            featuresCount: number;
            geometryType: string;
            idColumn: string | null;
            name: string | null;
            title: string | null;
        }
        | null;
        index: | {
            bytes: number;
            levels: number;
            nodeSize: number;
            overlap: number
            | null;
        }
        | null;
        ok: boolean;
        path: string;
        problems: CheckProblem[];
        size: number
        | null;
        version: string | null;
    }
    Index
    etag features header index ok path problems size version
    etag: string | null

    Version tag reported by the connector (ETag, file metadata), or null.

    features:
        | {
            bbox: BBox
            | null;
            bytes: number;
            checked: number;
            complete: boolean;
            withoutGeometry: number;
        }
        | null

    Feature scan summary, or null when skipped (quick) or impossible.

    Type Declaration

    • {
          bbox: BBox | null;
          bytes: number;
          checked: number;
          complete: boolean;
          withoutGeometry: number;
      }
      • bbox: BBox | null

        Extent of the decoded geometries, or null if none.

      • bytes: number

        Feature bytes read.

      • checked: number

        Stored features read and decoded.

      • complete: boolean

        Whether the whole feature section was read (see maxBytes).

      • withoutGeometry: number

        Of those, features without usable geometry (empty, unknown or abstract types).

    • null
    header:
        | {
            columns: { name: string; type: string }[];
            crs: string | null;
            crsSupport: "lonlat" | "webmercator" | "needs-projection";
            description: string | null;
            envelope: BBox | null;
            featuresCount: number;
            geometryType: string;
            idColumn: string | null;
            name: string | null;
            title: string | null;
        }
        | null

    Header summary, or null if the header could not be read.

    Type Declaration

    • {
          columns: { name: string; type: string }[];
          crs: string | null;
          crsSupport: "lonlat" | "webmercator" | "needs-projection";
          description: string | null;
          envelope: BBox | null;
          featuresCount: number;
          geometryType: string;
          idColumn: string | null;
          name: string | null;
          title: string | null;
      }
      • columns: { name: string; type: string }[]
      • crs: string | null

        CRS identifier (e.g. EPSG:4326) or name, or null without one.

      • crsSupport: "lonlat" | "webmercator" | "needs-projection"

        How fgb-vt reads the CRS: natively, or only with a Projection on the source.

      • description: string | null
      • envelope: BBox | null

        Envelope from the header, or null.

      • featuresCount: number

        Feature count from the header (0: unknown).

      • geometryType: string
      • idColumn: string | null

        Feature id column fgb-vt detects, or null.

      • name: string | null
      • title: string | null
    • null
    index:
        | {
            bytes: number;
            levels: number;
            nodeSize: number;
            overlap: number
            | null;
        }
        | null

    Spatial index summary, or null without an index.

    Type Declaration

    • { bytes: number; levels: number; nodeSize: number; overlap: number | null }
      • bytes: number
      • levels: number

        Tree levels, including leaves and root.

      • nodeSize: number
      • overlap: number | null

        Total box area of the nodes directly above the leaves, divided by the area of the root box (null for trees too small to tell). Close to 1 means compact, well-sorted nodes; large values mean nodes that overlap, so tiles read many features they do not need.

    • null
    ok: boolean

    true when no errors were found (warnings allowed).

    path: string

    The path checked.

    problems: CheckProblem[]

    Problems found, errors first.

    size: number | null

    File size in bytes, when the connector reports it.

    version: string | null

    Format version from the magic bytes, e.g. 3.0.1, or null if unreadable.

    Settings
    Member Visibility

    On This Page
    Properties