diff --git a/README.md b/README.md index 373701f..01569a9 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ downloads - bundle + bundle docs-ts diff --git a/TODO b/TODO index 61bb6c3..17dcddb 100644 --- a/TODO +++ b/TODO @@ -1,5 +1,4 @@ # TODO [ ] - Write more tests coverage to ensure validation is working as expected -[ ] - update validation to work with Vectored data [ ] - update the spec to include vectored data and a Tile concept diff --git a/docs/classes/Layer.html b/docs/classes/Layer.html index 5039bb8..d0ddfc2 100644 --- a/docs/classes/Layer.html +++ b/docs/classes/Layer.html @@ -1,4 +1,4 @@ -Layer | s2json-spec - v1.4.0

Class Layer

Layer Class to contain the layer information for splitting or simplifying

+Layer | s2json-spec - v1.4.1

Class Layer

Layer Class to contain the layer information for splitting or simplifying

Constructors

Properties

features name @@ -6,4 +6,4 @@
  • features: VectorFeatures[] = []

    the layer's features

  • Returns Layer

    Properties

    features: VectorFeatures[] = []

    the layer's features

    name: string

    the layer name

    -
    +
    diff --git a/docs/classes/Tile.html b/docs/classes/Tile.html index 34a5f92..c109f61 100644 --- a/docs/classes/Tile.html +++ b/docs/classes/Tile.html @@ -1,4 +1,4 @@ -Tile | s2json-spec - v1.4.0

    Class Tile

    Tile Class to contain the tile information for splitting or simplifying

    +Tile | s2json-spec - v1.4.1

    Class Tile

    Tile Class to contain the tile information for splitting or simplifying

    Constructors

    Properties

    id layers @@ -23,4 +23,4 @@ is needed.

    Parameters

    • tolerance: number

      tolerance

    • Optionalmaxzoom: number

      max zoom at which to simplify

      -

    Returns void

    +

    Returns void

    diff --git a/docs/classes/TileStore.html b/docs/classes/TileStore.html index 5346705..902bc34 100644 --- a/docs/classes/TileStore.html +++ b/docs/classes/TileStore.html @@ -1,4 +1,4 @@ -TileStore | s2json-spec - v1.4.0

    Class TileStore

    TileStore Class is a tile-lookup system that splits and simplifies as needed for each tile request

    +TileStore | s2json-spec - v1.4.1

    Class TileStore

    TileStore Class is a tile-lookup system that splits and simplifies as needed for each tile request

    Constructors

    Methods

    addFeature getTile @@ -13,4 +13,4 @@
    • Parameters

      • startID: bigint

        where to start tiling

      • OptionalendID: bigint

        where to stop tiling

      • endZoom: number = ...

        stop tiling at this zoom

        -

      Returns void

    +

    Returns void

    diff --git a/docs/functions/IJtoST.html b/docs/functions/IJtoST.html index 439e3e7..df00a17 100644 --- a/docs/functions/IJtoST.html +++ b/docs/functions/IJtoST.html @@ -1,4 +1,4 @@ -IJtoST | s2json-spec - v1.4.0

    Function IJtoST

    • Convert from ij space to st space (ij are whole numbers ranging an entire u30)

      +IJtoST | s2json-spec - v1.4.1

      Function IJtoST

      • Convert from ij space to st space (ij are whole numbers ranging an entire u30)

        Parameters

        • i: number

          input I or J

        Returns number

        output S or T

        -
      +
    diff --git a/docs/functions/MercPoint.altitudeFromMercatorZ.html b/docs/functions/MercPoint.altitudeFromMercatorZ.html index eb57d5a..181db6e 100644 --- a/docs/functions/MercPoint.altitudeFromMercatorZ.html +++ b/docs/functions/MercPoint.altitudeFromMercatorZ.html @@ -1,5 +1,5 @@ -altitudeFromMercatorZ | s2json-spec - v1.4.0

    Function altitudeFromMercatorZ

    • Convert mercator projection's Z-Value to altitude

      +altitudeFromMercatorZ | s2json-spec - v1.4.1

      Function altitudeFromMercatorZ

      • Convert mercator projection's Z-Value to altitude

        Parameters

        • z: number

          in meters

        • y: number

          in radians

        Returns number

        the altitude

        -
      +
    diff --git a/docs/functions/MercPoint.bboxToXYZBounds.html b/docs/functions/MercPoint.bboxToXYZBounds.html index 9b83ec0..a80881b 100644 --- a/docs/functions/MercPoint.bboxToXYZBounds.html +++ b/docs/functions/MercPoint.bboxToXYZBounds.html @@ -1,4 +1,4 @@ -bboxToXYZBounds | s2json-spec - v1.4.0

    Function bboxToXYZBounds

    • Convert a bbox of the form [w, s, e, n] to a tile's bounding box +bboxToXYZBounds | s2json-spec - v1.4.1

      Function bboxToXYZBounds

      • Convert a bbox of the form [w, s, e, n] to a tile's bounding box in the form of { minX, maxX, minY, maxY } The bbox can be in lon-lat (WGS84) or WebMercator (900913) The default expectation is in WebMercator (900913)

        @@ -10,4 +10,4 @@

      Returns {
          maxX: number;
          maxY: number;
          minX: number;
          minY: number;
      }

      • the tile's bounding box
      -
      • maxX: number
      • maxY: number
      • minX: number
      • minY: number
    +
    diff --git a/docs/functions/MercPoint.convert.html b/docs/functions/MercPoint.convert.html index 14df6df..6f3f265 100644 --- a/docs/functions/MercPoint.convert.html +++ b/docs/functions/MercPoint.convert.html @@ -1,4 +1,4 @@ -convert | s2json-spec - v1.4.0
    • Convert a bbox of the form [w, s, e, n] to a bbox of the form [w, s, e, n] +convert | s2json-spec - v1.4.1

      • Convert a bbox of the form [w, s, e, n] to a bbox of the form [w, s, e, n] The result can be in lon-lat (WGS84) or WebMercator (900913) If the input is in WebMercator (900913), the outSource should be set to 'WGS84'

        Parameters

        • bbox: BBox

          the bounding box to convert

          @@ -6,4 +6,4 @@

        Returns BBox

        • the converted bbox
        -
      +
    diff --git a/docs/functions/MercPoint.latFromMercatorY.html b/docs/functions/MercPoint.latFromMercatorY.html index 8e65e2f..79cb92a 100644 --- a/docs/functions/MercPoint.latFromMercatorY.html +++ b/docs/functions/MercPoint.latFromMercatorY.html @@ -1,4 +1,4 @@ -latFromMercatorY | s2json-spec - v1.4.0

    Function latFromMercatorY

    • Convert mercator projection's Y-Value to latitude

      +latFromMercatorY | s2json-spec - v1.4.1

      Function latFromMercatorY

      • Convert mercator projection's Y-Value to latitude

        Parameters

        • y: number

          in radians

        Returns number

        the latitude

        -
      +
    diff --git a/docs/functions/MercPoint.llToMerc.html b/docs/functions/MercPoint.llToMerc.html index 8cdcd18..57ba33a 100644 --- a/docs/functions/MercPoint.llToMerc.html +++ b/docs/functions/MercPoint.llToMerc.html @@ -1,6 +1,6 @@ -llToMerc | s2json-spec - v1.4.0
    • Convert Longitude and Latitude to a mercator x-y coordinates

      +llToMerc | s2json-spec - v1.4.1
      • Convert Longitude and Latitude to a mercator x-y coordinates

        Parameters

        • ll: Point

          the longitude and latitude

        Returns Point

        • the mercator pixel
        -
      +
    diff --git a/docs/functions/MercPoint.llToPX.html b/docs/functions/MercPoint.llToPX.html index 2c22b1f..30ee589 100644 --- a/docs/functions/MercPoint.llToPX.html +++ b/docs/functions/MercPoint.llToPX.html @@ -1,4 +1,4 @@ -llToPX | s2json-spec - v1.4.0
    • Convert Longitude and Latitude to a mercator pixel coordinate

      +llToPX | s2json-spec - v1.4.1
      • Convert Longitude and Latitude to a mercator pixel coordinate

        Parameters

        • ll: Point

          the longitude and latitude

        • zoom: number

          the zoom level

        • antiMeridian: boolean = false

          true if you want to use the antimeridian

          @@ -6,4 +6,4 @@

        Returns Point

        • the mercator pixel
        -
      +
    diff --git a/docs/functions/MercPoint.llToTile.html b/docs/functions/MercPoint.llToTile.html index 78c42e5..1036b92 100644 --- a/docs/functions/MercPoint.llToTile.html +++ b/docs/functions/MercPoint.llToTile.html @@ -1,8 +1,8 @@ -llToTile | s2json-spec - v1.4.0
    • Convert a lat-lon and zoom to the tile's x-y coordinates

      +llToTile | s2json-spec - v1.4.1
      • Convert a lat-lon and zoom to the tile's x-y coordinates

        Parameters

        • ll: Point

          the lat-lon

        • zoom: number

          the zoom

        • tileSize: number = 512

          in pixels

        Returns Point

        • the tile x-y
        -
      +
    diff --git a/docs/functions/MercPoint.llToTilePx.html b/docs/functions/MercPoint.llToTilePx.html index 0ce8c47..54b3ac8 100644 --- a/docs/functions/MercPoint.llToTilePx.html +++ b/docs/functions/MercPoint.llToTilePx.html @@ -1,8 +1,8 @@ -llToTilePx | s2json-spec - v1.4.0
    • given a lon-lat and tile, find the offset in pixels

      +llToTilePx | s2json-spec - v1.4.1
      • given a lon-lat and tile, find the offset in pixels

        Parameters

        • ll: Point

          the lon-lat

        • tile: Point3D

          the tile

        • tileSize: number = 512

          in pixels

        Returns Point

        • the tile x-y
        -
      +
    diff --git a/docs/functions/MercPoint.lngFromMercatorX.html b/docs/functions/MercPoint.lngFromMercatorX.html index 50764b7..e7b124e 100644 --- a/docs/functions/MercPoint.lngFromMercatorX.html +++ b/docs/functions/MercPoint.lngFromMercatorX.html @@ -1,4 +1,4 @@ -lngFromMercatorX | s2json-spec - v1.4.0

    Function lngFromMercatorX

    • Convert mercator projection's X-Value to longitude

      +lngFromMercatorX | s2json-spec - v1.4.1

      Function lngFromMercatorX

      • Convert mercator projection's X-Value to longitude

        Parameters

        • x: number

          in radians

        Returns number

        the longitude

        -
      +
    diff --git a/docs/functions/MercPoint.mercToLL.html b/docs/functions/MercPoint.mercToLL.html index feb2102..06f7192 100644 --- a/docs/functions/MercPoint.mercToLL.html +++ b/docs/functions/MercPoint.mercToLL.html @@ -1,6 +1,6 @@ -mercToLL | s2json-spec - v1.4.0
    • Convert mercator x-y coordinates to Longitude and Latitude

      +mercToLL | s2json-spec - v1.4.1
      • Convert mercator x-y coordinates to Longitude and Latitude

        Parameters

        • merc: Point

          the mercator pixel

        Returns Point

        • the longitude and latitude
        -
      +
    diff --git a/docs/functions/MercPoint.mercatorLatScale.html b/docs/functions/MercPoint.mercatorLatScale.html index 953db22..bfd1261 100644 --- a/docs/functions/MercPoint.mercatorLatScale.html +++ b/docs/functions/MercPoint.mercatorLatScale.html @@ -1,6 +1,6 @@ -mercatorLatScale | s2json-spec - v1.4.0

    Function mercatorLatScale

    • Determine the Mercator scale factor for a given latitude, see +mercatorLatScale | s2json-spec - v1.4.1

      Function mercatorLatScale

      +
    diff --git a/docs/functions/MercPoint.mercatorXfromLng.html b/docs/functions/MercPoint.mercatorXfromLng.html index 3a7fb77..68d75a8 100644 --- a/docs/functions/MercPoint.mercatorXfromLng.html +++ b/docs/functions/MercPoint.mercatorXfromLng.html @@ -1,4 +1,4 @@ -mercatorXfromLng | s2json-spec - v1.4.0

    Function mercatorXfromLng

    • Convert longitude to mercator projection X-Value

      +mercatorXfromLng | s2json-spec - v1.4.1

      Function mercatorXfromLng

      • Convert longitude to mercator projection X-Value

        Parameters

        • lng: number

          in degrees

        Returns number

        the X-Value

        -
      +
    diff --git a/docs/functions/MercPoint.mercatorYfromLat.html b/docs/functions/MercPoint.mercatorYfromLat.html index a25ee9d..d2ab74d 100644 --- a/docs/functions/MercPoint.mercatorYfromLat.html +++ b/docs/functions/MercPoint.mercatorYfromLat.html @@ -1,4 +1,4 @@ -mercatorYfromLat | s2json-spec - v1.4.0

    Function mercatorYfromLat

    • Convert latitude to mercator projection Y-Value

      +mercatorYfromLat | s2json-spec - v1.4.1

      Function mercatorYfromLat

      • Convert latitude to mercator projection Y-Value

        Parameters

        • lat: number

          in degrees

        Returns number

        the Y-Value

        -
      +
    diff --git a/docs/functions/MercPoint.mercatorZfromAltitude.html b/docs/functions/MercPoint.mercatorZfromAltitude.html index 54bc511..52965ad 100644 --- a/docs/functions/MercPoint.mercatorZfromAltitude.html +++ b/docs/functions/MercPoint.mercatorZfromAltitude.html @@ -1,5 +1,5 @@ -mercatorZfromAltitude | s2json-spec - v1.4.0

    Function mercatorZfromAltitude

    • Convert altitude to mercator projection Z-Value

      +mercatorZfromAltitude | s2json-spec - v1.4.1

      Function mercatorZfromAltitude

      • Convert altitude to mercator projection Z-Value

        Parameters

        • altitude: number

          in meters

        • lat: number

          in degrees

        Returns number

        the Z-Value

        -
      +
    diff --git a/docs/functions/MercPoint.pxToLL.html b/docs/functions/MercPoint.pxToLL.html index 5561b75..2d52c21 100644 --- a/docs/functions/MercPoint.pxToLL.html +++ b/docs/functions/MercPoint.pxToLL.html @@ -1,8 +1,8 @@ -pxToLL | s2json-spec - v1.4.0
    • Convert mercator pixel coordinates to Longitude and Latitude

      +pxToLL | s2json-spec - v1.4.1
      • Convert mercator pixel coordinates to Longitude and Latitude

        Parameters

        • px: Point

          the mercator pixel

        • zoom: number

          the zoom level

        • tileSize: number = 512

          in pixels

        Returns Point

        • the longitude and latitude
        -
      +
    diff --git a/docs/functions/MercPoint.pxToTile.html b/docs/functions/MercPoint.pxToTile.html index 041853f..c598017 100644 --- a/docs/functions/MercPoint.pxToTile.html +++ b/docs/functions/MercPoint.pxToTile.html @@ -1,7 +1,7 @@ -pxToTile | s2json-spec - v1.4.0
    • Convert a pixel coordinate to a tile x-y coordinate

      +pxToTile | s2json-spec - v1.4.1
      • Convert a pixel coordinate to a tile x-y coordinate

        Parameters

        • px: Point

          the pixel

        • tileSize: number = 512

          in pixels

        Returns Point

        • the tile x-y
        -
      +
    diff --git a/docs/functions/MercPoint.tilePxBounds.html b/docs/functions/MercPoint.tilePxBounds.html index 7109c4d..323422f 100644 --- a/docs/functions/MercPoint.tilePxBounds.html +++ b/docs/functions/MercPoint.tilePxBounds.html @@ -1,7 +1,7 @@ -tilePxBounds | s2json-spec - v1.4.0
    • Convert a tile x-y-z to a bbox of the form [w, s, e, n]

      +tilePxBounds | s2json-spec - v1.4.1
      • Convert a tile x-y-z to a bbox of the form [w, s, e, n]

        Parameters

        • tile: Point3D

          the tile

        • tileSize: number = 512

          in pixels

        Returns BBox

        • the bbox
        -
      +
    diff --git a/docs/functions/MercPoint.xyzToBBOX.html b/docs/functions/MercPoint.xyzToBBOX.html index fdbadd3..4058be4 100644 --- a/docs/functions/MercPoint.xyzToBBOX.html +++ b/docs/functions/MercPoint.xyzToBBOX.html @@ -1,4 +1,4 @@ -xyzToBBOX | s2json-spec - v1.4.0
    • Convert a tile x-y-z to a bbox of the form [w, s, e, n] +xyzToBBOX | s2json-spec - v1.4.1

      • Convert a tile x-y-z to a bbox of the form [w, s, e, n] The result can be in lon-lat (WGS84) or WebMercator (900913) The default result is in WebMercator (900913)

        Parameters

        • x: number

          the x tile position

          @@ -10,4 +10,4 @@

        Returns BBox

        • the bounding box in WGS84
        -
      +
    diff --git a/docs/functions/S2CellID.boundsST.html b/docs/functions/S2CellID.boundsST.html index c44e94f..67357b8 100644 --- a/docs/functions/S2CellID.boundsST.html +++ b/docs/functions/S2CellID.boundsST.html @@ -1,5 +1,5 @@ -boundsST | s2json-spec - v1.4.0
    • Given an S2CellID and level (zoom), get the S-T bounding range of that cell

      +boundsST | s2json-spec - v1.4.1
      • Given an S2CellID and level (zoom), get the S-T bounding range of that cell

        Parameters

        • id: bigint

          the S2CellID

        • lev: number

          zoom level

        Returns BBox

        [sMin, tMin, sMax, tMax]

        -
      +
    diff --git a/docs/functions/S2CellID.centerST.html b/docs/functions/S2CellID.centerST.html index a8a69fb..5e8e259 100644 --- a/docs/functions/S2CellID.centerST.html +++ b/docs/functions/S2CellID.centerST.html @@ -1,4 +1,4 @@ -centerST | s2json-spec - v1.4.0
    • Given an S2CellID and level (zoom), get the center point of that cell in S-T space

      +centerST | s2json-spec - v1.4.1
      • Given an S2CellID and level (zoom), get the center point of that cell in S-T space

        Parameters

        • id: bigint

          the S2CellID

        Returns [face: Face, s: number, t: number]

        [face, s, t]

        -
      +
    diff --git a/docs/functions/S2CellID.child.html b/docs/functions/S2CellID.child.html index 4f3316a..666d6c4 100644 --- a/docs/functions/S2CellID.child.html +++ b/docs/functions/S2CellID.child.html @@ -1,5 +1,5 @@ -child | s2json-spec - v1.4.0
    • Given an S2CellID, get the quad child tile of your choice [0, 4)

      +child | s2json-spec - v1.4.1
      • Given an S2CellID, get the quad child tile of your choice [0, 4)

        Parameters

        • id: bigint

          the S2CellID

        • pos:
              | 0n
              | 3n
              | 1n
              | 2n

          quad position 0, 1, 2, or 3

        Returns bigint

        the child tile at that position

        -
      +
    diff --git a/docs/functions/S2CellID.childPosition.html b/docs/functions/S2CellID.childPosition.html index 88701e0..0b69061 100644 --- a/docs/functions/S2CellID.childPosition.html +++ b/docs/functions/S2CellID.childPosition.html @@ -1,5 +1,5 @@ -childPosition | s2json-spec - v1.4.0

    Function childPosition

    • Given an S2CellID, get the quad position relative to its parent

      +childPosition | s2json-spec - v1.4.1

      Function childPosition

      • Given an S2CellID, get the quad position relative to its parent

        Parameters

        • id: bigint

          the S2CellID

        • level: number

          zoom level

        Returns number

        the child tile at that position

        -
      +
    diff --git a/docs/functions/S2CellID.children.html b/docs/functions/S2CellID.children.html index 4cda34b..55e6946 100644 --- a/docs/functions/S2CellID.children.html +++ b/docs/functions/S2CellID.children.html @@ -1,5 +1,5 @@ -children | s2json-spec - v1.4.0
    • Given an S2CellID, get all the quad children tiles

      +children | s2json-spec - v1.4.1
      • Given an S2CellID, get all the quad children tiles

        Parameters

        • id: bigint

          the S2CellID

        • orientation: number = 0

          orientation of the child (0 or 1)

        Returns [bigint, bigint, bigint, bigint]

        the child tile at that position

        -
      +
    diff --git a/docs/functions/S2CellID.childrenIJ.html b/docs/functions/S2CellID.childrenIJ.html index d14d73b..2b3e8a9 100644 --- a/docs/functions/S2CellID.childrenIJ.html +++ b/docs/functions/S2CellID.childrenIJ.html @@ -1,7 +1,7 @@ -childrenIJ | s2json-spec - v1.4.0
    • Given a Face-level-i-j coordinate, get all its quad children tiles

      +childrenIJ | s2json-spec - v1.4.1
      • Given a Face-level-i-j coordinate, get all its quad children tiles

        Parameters

        • face: Face

          the Face

        • level: number

          zoom level

        • i: number

          i coordinate

        • j: number

          j coordinate

        Returns [blID: bigint, brID: bigint, tlID: bigint, trID: bigint]

        the child tile at that position

        -
      +
    diff --git a/docs/functions/S2CellID.contains.html b/docs/functions/S2CellID.contains.html index dd71f71..6718bb7 100644 --- a/docs/functions/S2CellID.contains.html +++ b/docs/functions/S2CellID.contains.html @@ -1,5 +1,5 @@ -contains | s2json-spec - v1.4.0
    • Check if the first S2CellID contains the second.

      +contains | s2json-spec - v1.4.1
      • Check if the first S2CellID contains the second.

        Parameters

        • a: bigint

          the first S2CellID

        • b: bigint

          the second S2CellID

        Returns boolean

        true if a contains b

        -
      +
    diff --git a/docs/functions/S2CellID.distance.html b/docs/functions/S2CellID.distance.html index cb2222c..654fe39 100644 --- a/docs/functions/S2CellID.distance.html +++ b/docs/functions/S2CellID.distance.html @@ -1,5 +1,5 @@ -distance | s2json-spec - v1.4.0
    • Given an S2CellID, get the distance it spans (or length it covers)

      +distance | s2json-spec - v1.4.1
      • Given an S2CellID, get the distance it spans (or length it covers)

        Parameters

        • id: bigint

          the S2CellID

        • Optionallev: number

          optional zoom level

        Returns bigint

        distance

        -
      +
    diff --git a/docs/functions/S2CellID.face.html b/docs/functions/S2CellID.face.html index 621f034..e6fb3ac 100644 --- a/docs/functions/S2CellID.face.html +++ b/docs/functions/S2CellID.face.html @@ -1,4 +1,4 @@ -face | s2json-spec - v1.4.0
    • Given an S2CellID, get the face it's located in

      +face | s2json-spec - v1.4.1
      • Given an S2CellID, get the face it's located in

        Parameters

        • id: bigint

          the S2CellID

        Returns Face

        face of the cell

        -
      +
    diff --git a/docs/functions/S2CellID.fromDistance.html b/docs/functions/S2CellID.fromDistance.html index 7a73bc3..ab26c1b 100644 --- a/docs/functions/S2CellID.fromDistance.html +++ b/docs/functions/S2CellID.fromDistance.html @@ -1,5 +1,5 @@ -fromDistance | s2json-spec - v1.4.0

    Function fromDistance

    • Create an S2CellID given a distance and level (zoom). Default level is 30n

      +fromDistance | s2json-spec - v1.4.1

      Function fromDistance

      • Create an S2CellID given a distance and level (zoom). Default level is 30n

        Parameters

        • distance: bigint

          distance

        • level: bigint = MAX_LEVEL

          level

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.fromFace.html b/docs/functions/S2CellID.fromFace.html index f10f322..a7c7b2f 100644 --- a/docs/functions/S2CellID.fromFace.html +++ b/docs/functions/S2CellID.fromFace.html @@ -1,4 +1,4 @@ -fromFace | s2json-spec - v1.4.0
    • Create a default S2CellID given a face on the sphere [0-6)

      +fromFace | s2json-spec - v1.4.1
      • Create a default S2CellID given a face on the sphere [0-6)

        Parameters

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.fromIJ.html b/docs/functions/S2CellID.fromIJ.html index bf55c4e..01103d2 100644 --- a/docs/functions/S2CellID.fromIJ.html +++ b/docs/functions/S2CellID.fromIJ.html @@ -1,7 +1,7 @@ -fromIJ | s2json-spec - v1.4.0
    • Create an S2CellID from an Face-I-J coordinate and map it to a zoom if desired.

      +fromIJ | s2json-spec - v1.4.1
      • Create an S2CellID from an Face-I-J coordinate and map it to a zoom if desired.

        Parameters

        • face: Face

          the face

        • i: number

          i coordinate

        • j: number

          j coordinate

        • Optionallevel: number

          zoom level

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.fromIJSame.html b/docs/functions/S2CellID.fromIJSame.html index c10d1e5..9923cfd 100644 --- a/docs/functions/S2CellID.fromIJSame.html +++ b/docs/functions/S2CellID.fromIJSame.html @@ -1,7 +1,7 @@ -fromIJSame | s2json-spec - v1.4.0
    • Build an S2CellID given a Face-I-J, but ensure the face is the same if desired

      +fromIJSame | s2json-spec - v1.4.1
      • Build an S2CellID given a Face-I-J, but ensure the face is the same if desired

        Parameters

        • face: Face

          the Face

        • i: number

          the I coordinate

        • j: number

          the J coordinate

        • sameFace: boolean

          if the face should be the same

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.fromIJWrap.html b/docs/functions/S2CellID.fromIJWrap.html index 967145e..b1622b1 100644 --- a/docs/functions/S2CellID.fromIJWrap.html +++ b/docs/functions/S2CellID.fromIJWrap.html @@ -1,6 +1,6 @@ -fromIJWrap | s2json-spec - v1.4.0
    • Build an S2CellID given a Face-I-J, but ensure it's a legal value, otherwise wrap before creation

      +fromIJWrap | s2json-spec - v1.4.1
      • Build an S2CellID given a Face-I-J, but ensure it's a legal value, otherwise wrap before creation

        Parameters

        • face: Face

          the Face

        • i: number

          the I coordinate

        • j: number

          the J coordinate

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.fromLonLat.html b/docs/functions/S2CellID.fromLonLat.html index 8029f5d..5c1bd3b 100644 --- a/docs/functions/S2CellID.fromLonLat.html +++ b/docs/functions/S2CellID.fromLonLat.html @@ -1,5 +1,5 @@ -fromLonLat | s2json-spec - v1.4.0
    • Create an S2CellID from a lon-lat coordinate

      +fromLonLat | s2json-spec - v1.4.1
      • Create an S2CellID from a lon-lat coordinate

        Parameters

        • lon: number

          longitude

        • lat: number

          latitude

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.fromS2Point.html b/docs/functions/S2CellID.fromS2Point.html index 4de59c3..2a77e0d 100644 --- a/docs/functions/S2CellID.fromS2Point.html +++ b/docs/functions/S2CellID.fromS2Point.html @@ -1,4 +1,4 @@ -fromS2Point | s2json-spec - v1.4.0

    Function fromS2Point

    • Create an S2CellID from an XYZ Point

      +fromS2Point | s2json-spec - v1.4.1

      Function fromS2Point

      • Create an S2CellID from an XYZ Point

        Parameters

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.fromST.html b/docs/functions/S2CellID.fromST.html index 9d8c00d..d95ae9e 100644 --- a/docs/functions/S2CellID.fromST.html +++ b/docs/functions/S2CellID.fromST.html @@ -1,6 +1,6 @@ -fromST | s2json-spec - v1.4.0
    • Create an S2CellID from an Face-S-T coordinate

      +fromST | s2json-spec - v1.4.1
      • Create an S2CellID from an Face-S-T coordinate

        Parameters

        • face: Face

          the face

        • s: number

          s coordinate

        • t: number

          t coordinate

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.fromUV.html b/docs/functions/S2CellID.fromUV.html index 217a843..fa27f35 100644 --- a/docs/functions/S2CellID.fromUV.html +++ b/docs/functions/S2CellID.fromUV.html @@ -1,6 +1,6 @@ -fromUV | s2json-spec - v1.4.0
    • Create an S2CellID from an Face-U-V coordinate

      +fromUV | s2json-spec - v1.4.1
      • Create an S2CellID from an Face-U-V coordinate

        Parameters

        • face: Face

          the face

        • u: number

          u coordinate

        • v: number

          v coordinate

        Returns bigint

        the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.intersects.html b/docs/functions/S2CellID.intersects.html index 535698f..71eba7c 100644 --- a/docs/functions/S2CellID.intersects.html +++ b/docs/functions/S2CellID.intersects.html @@ -1,5 +1,5 @@ -intersects | s2json-spec - v1.4.0
    • Check if an S2CellID intersects another. This includes edges touching.

      +intersects | s2json-spec - v1.4.1
      • Check if an S2CellID intersects another. This includes edges touching.

        Parameters

        • a: bigint

          the first S2CellID

        • b: bigint

          the second S2CellID

        Returns boolean

        true if a intersects b

        -
      +
    diff --git a/docs/functions/S2CellID.isFace.html b/docs/functions/S2CellID.isFace.html index 2c7fc06..a7f23fd 100644 --- a/docs/functions/S2CellID.isFace.html +++ b/docs/functions/S2CellID.isFace.html @@ -1,4 +1,4 @@ -isFace | s2json-spec - v1.4.0
    • Given an S2CellID, check if it is a Face Cell.

      +isFace | s2json-spec - v1.4.1
      • Given an S2CellID, check if it is a Face Cell.

        Parameters

        • id: bigint

          the S2CellID

        Returns boolean

        true if the cell is a face (lowest zoom level)

        -
      +
    diff --git a/docs/functions/S2CellID.isLeaf.html b/docs/functions/S2CellID.isLeaf.html index 4d9d958..d96cce4 100644 --- a/docs/functions/S2CellID.isLeaf.html +++ b/docs/functions/S2CellID.isLeaf.html @@ -1,4 +1,4 @@ -isLeaf | s2json-spec - v1.4.0
    • Check if the S2CellID is a leaf value. This means it's the smallest possible cell

      +isLeaf | s2json-spec - v1.4.1
      • Check if the S2CellID is a leaf value. This means it's the smallest possible cell

        Parameters

        • id: bigint

          input S2CellID

        Returns boolean

        true if the S2CellID is a leaf

        -
      +
    diff --git a/docs/functions/S2CellID.level.html b/docs/functions/S2CellID.level.html index eabe78f..0e294f7 100644 --- a/docs/functions/S2CellID.level.html +++ b/docs/functions/S2CellID.level.html @@ -1,4 +1,4 @@ -level | s2json-spec - v1.4.0
    • Given an S2CellID, find the level (zoom) its located in

      +level | s2json-spec - v1.4.1
      • Given an S2CellID, find the level (zoom) its located in

        Parameters

        • id: bigint

          the S2CellID

        Returns number

        zoom level

        -
      +
    diff --git a/docs/functions/S2CellID.neighbors.html b/docs/functions/S2CellID.neighbors.html index d287bc4..731953e 100644 --- a/docs/functions/S2CellID.neighbors.html +++ b/docs/functions/S2CellID.neighbors.html @@ -1,4 +1,4 @@ -neighbors | s2json-spec - v1.4.0
    • Given an S2CellID, find the neighboring S2CellIDs

      +neighbors | s2json-spec - v1.4.1
      • Given an S2CellID, find the neighboring S2CellIDs

        Parameters

        • id: bigint

          the S2CellID

        Returns [bigint, bigint, bigint, bigint]

        [up, right, down, left]

        -
      +
    diff --git a/docs/functions/S2CellID.neighborsIJ.html b/docs/functions/S2CellID.neighborsIJ.html index 2066198..d8d8ab4 100644 --- a/docs/functions/S2CellID.neighborsIJ.html +++ b/docs/functions/S2CellID.neighborsIJ.html @@ -1,7 +1,7 @@ -neighborsIJ | s2json-spec - v1.4.0

    Function neighborsIJ

    • Given a Face-I-J and a desired level (zoom), find the neighboring S2CellIDs

      +neighborsIJ | s2json-spec - v1.4.1

      Function neighborsIJ

      • Given a Face-I-J and a desired level (zoom), find the neighboring S2CellIDs

        Parameters

        • face: Face

          the Face

        • i: number

          the I coordinate

        • j: number

          the J coordinate

        • level: number

          the zoom level (desired)

        Returns [bigint, bigint, bigint, bigint]

        neighbors: [down, right, up, left]

        -
      +
    diff --git a/docs/functions/S2CellID.next.html b/docs/functions/S2CellID.next.html index d1c82c6..d3eed6c 100644 --- a/docs/functions/S2CellID.next.html +++ b/docs/functions/S2CellID.next.html @@ -1,4 +1,4 @@ -next | s2json-spec - v1.4.0
    • Get the next S2CellID in the hilbert space

      +next | s2json-spec - v1.4.1
      • Get the next S2CellID in the hilbert space

        Parameters

        • id: bigint

          input S2CellID

        Returns bigint

        the next S2CellID in the hilbert space

        -
      +
    diff --git a/docs/functions/S2CellID.parent.html b/docs/functions/S2CellID.parent.html index 66e8fe8..3d48e5f 100644 --- a/docs/functions/S2CellID.parent.html +++ b/docs/functions/S2CellID.parent.html @@ -1,5 +1,5 @@ -parent | s2json-spec - v1.4.0
    • Given an S2CellID, get the parent quad tile

      +parent | s2json-spec - v1.4.1
      • Given an S2CellID, get the parent quad tile

        Parameters

        • id: bigint

          the S2CellID

        • Optionallevel: number

          zoom level

        Returns bigint

        the parent of the input S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.pos.html b/docs/functions/S2CellID.pos.html index c74c076..499f1a3 100644 --- a/docs/functions/S2CellID.pos.html +++ b/docs/functions/S2CellID.pos.html @@ -1,4 +1,4 @@ -pos | s2json-spec - v1.4.0
    • Given an S2CellID, find the quad tree position [0-4) it's located in

      +pos | s2json-spec - v1.4.1
      • Given an S2CellID, find the quad tree position [0-4) it's located in

        Parameters

        • id: bigint

          the S2CellID

        Returns bigint

        quad tree position

        -
      +
    diff --git a/docs/functions/S2CellID.prev.html b/docs/functions/S2CellID.prev.html index 066372c..7049d05 100644 --- a/docs/functions/S2CellID.prev.html +++ b/docs/functions/S2CellID.prev.html @@ -1,4 +1,4 @@ -prev | s2json-spec - v1.4.0
    • Get the previous S2CellID in the hilbert space

      +prev | s2json-spec - v1.4.1
      • Get the previous S2CellID in the hilbert space

        Parameters

        • id: bigint

          input S2CellID

        Returns bigint

        the previous S2CellID in the hilbert space

        -
      +
    diff --git a/docs/functions/S2CellID.range.html b/docs/functions/S2CellID.range.html index 69743af..eabb12c 100644 --- a/docs/functions/S2CellID.range.html +++ b/docs/functions/S2CellID.range.html @@ -1,4 +1,4 @@ -range | s2json-spec - v1.4.0
    • Given an S2CellID, get the hilbert range it spans

      +range | s2json-spec - v1.4.1
      • Given an S2CellID, get the hilbert range it spans

        Parameters

        • id: bigint

          the S2CellID

        Returns [min: bigint, max: bigint]

        [min, max]

        -
      +
    diff --git a/docs/functions/S2CellID.sizeIJ.html b/docs/functions/S2CellID.sizeIJ.html index f435b16..9d15b28 100644 --- a/docs/functions/S2CellID.sizeIJ.html +++ b/docs/functions/S2CellID.sizeIJ.html @@ -1,4 +1,4 @@ -sizeIJ | s2json-spec - v1.4.0
    • Return the range maximum of a level (zoom) in I-J space

      +sizeIJ | s2json-spec - v1.4.1
      • Return the range maximum of a level (zoom) in I-J space

        Parameters

        • level: number

          zoom level

        Returns number

        iMax or jMax

        -
      +
    diff --git a/docs/functions/S2CellID.sizeST.html b/docs/functions/S2CellID.sizeST.html index 10fefe8..6e73e05 100644 --- a/docs/functions/S2CellID.sizeST.html +++ b/docs/functions/S2CellID.sizeST.html @@ -1,4 +1,4 @@ -sizeST | s2json-spec - v1.4.0
    • Return the range maximum of a level (zoom) in S-T space

      +sizeST | s2json-spec - v1.4.1
      • Return the range maximum of a level (zoom) in S-T space

        Parameters

        • level: number

          zoom level

        Returns number

        sMax or tMax

        -
      +
    diff --git a/docs/functions/S2CellID.toIJ.html b/docs/functions/S2CellID.toIJ.html index 720ebff..f6a7628 100644 --- a/docs/functions/S2CellID.toIJ.html +++ b/docs/functions/S2CellID.toIJ.html @@ -1,6 +1,6 @@ -toIJ | s2json-spec - v1.4.0
    • Convert an S2CellID to a Face-I-J coordinate and provide its orientation. +toIJ | s2json-spec - v1.4.1

      • Convert an S2CellID to a Face-I-J coordinate and provide its orientation. If a level is provided, the I-J coordinates will be shifted to that level.

        Parameters

        • id: bigint

          the S2CellID

        • Optionallevel: number | bigint

          zoom level

        Returns [face: Face, i: number, j: number, orientation: number]

        face-i-j with orientation

        -
      +
    diff --git a/docs/functions/S2CellID.toLonLat.html b/docs/functions/S2CellID.toLonLat.html index d52fa43..5f4c55d 100644 --- a/docs/functions/S2CellID.toLonLat.html +++ b/docs/functions/S2CellID.toLonLat.html @@ -1,4 +1,4 @@ -toLonLat | s2json-spec - v1.4.0
    • Convert an S2CellID to an lon-lat coordinate

      +toLonLat | s2json-spec - v1.4.1
      • Convert an S2CellID to an lon-lat coordinate

        Parameters

        • id: bigint

          the S2CellID

        Returns [lon: number, lat: number]

        lon-lat coordinates

        -
      +
    diff --git a/docs/functions/S2CellID.toS2Point.html b/docs/functions/S2CellID.toS2Point.html index ab955a6..33ddb28 100644 --- a/docs/functions/S2CellID.toS2Point.html +++ b/docs/functions/S2CellID.toS2Point.html @@ -1,4 +1,4 @@ -toS2Point | s2json-spec - v1.4.0
    • Convert an S2CellID to an XYZ Point

      +toS2Point | s2json-spec - v1.4.1
      • Convert an S2CellID to an XYZ Point

        Parameters

        • id: bigint

          the S2CellID

        Returns Point3D

        a 3D vector

        -
      +
    diff --git a/docs/functions/S2CellID.toST.html b/docs/functions/S2CellID.toST.html index 4cd54a1..9e172c9 100644 --- a/docs/functions/S2CellID.toST.html +++ b/docs/functions/S2CellID.toST.html @@ -1,4 +1,4 @@ -toST | s2json-spec - v1.4.0
    • Convert an S2CellID to an Face-S-T coordinate

      +toST | s2json-spec - v1.4.1
      • Convert an S2CellID to an Face-S-T coordinate

        Parameters

        • id: bigint

          the S2CellID

        Returns [face: Face, s: number, t: number]

        face-s-t coordinate associated with the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.toUV.html b/docs/functions/S2CellID.toUV.html index 1e9f3d6..a8cde9c 100644 --- a/docs/functions/S2CellID.toUV.html +++ b/docs/functions/S2CellID.toUV.html @@ -1,4 +1,4 @@ -toUV | s2json-spec - v1.4.0
    • Convert an S2CellID to an Face-U-V coordinate

      +toUV | s2json-spec - v1.4.1
      • Convert an S2CellID to an Face-U-V coordinate

        Parameters

        • id: bigint

          the S2CellID

        Returns [face: Face, u: number, v: number]

        face-u-v coordinate associated with the S2CellID

        -
      +
    diff --git a/docs/functions/S2CellID.vertexNeighbors.html b/docs/functions/S2CellID.vertexNeighbors.html index 1ebf3fe..3184769 100644 --- a/docs/functions/S2CellID.vertexNeighbors.html +++ b/docs/functions/S2CellID.vertexNeighbors.html @@ -1,5 +1,5 @@ -vertexNeighbors | s2json-spec - v1.4.0

    Function vertexNeighbors

    • Given an S2CellID, find it's nearest neighbors associated with it

      +vertexNeighbors | s2json-spec - v1.4.1

      Function vertexNeighbors

      • Given an S2CellID, find it's nearest neighbors associated with it

        Parameters

        • id: bigint

          the S2CellID

        • Optionallev: number

          the zoom level (if not provided, defaults to current level of id)

        Returns bigint[]

        neighbors

        -
      +
    diff --git a/docs/functions/S2Point.add.html b/docs/functions/S2Point.add.html index e9e9631..499941c 100644 --- a/docs/functions/S2Point.add.html +++ b/docs/functions/S2Point.add.html @@ -1,7 +1,7 @@ -add | s2json-spec - v1.4.0
    • Take an XYZ Point and add an n to each component

      +add | s2json-spec - v1.4.1
      • Take an XYZ Point and add an n to each component

        Parameters

        • xyz: Point3D

          The XYZ Point to add to.

        • n: number

          The amount to add.

        Returns Point3D

        • The XYZ Point with the added amount.
        -
      +
    diff --git a/docs/functions/S2Point.addScalar.html b/docs/functions/S2Point.addScalar.html index b22bace..dca60b6 100644 --- a/docs/functions/S2Point.addScalar.html +++ b/docs/functions/S2Point.addScalar.html @@ -1,7 +1,7 @@ -addScalar | s2json-spec - v1.4.0

    Function addScalar

    • Take an XYZ Point and add another XYZ Point to it

      +addScalar | s2json-spec - v1.4.1

      Function addScalar

      • Take an XYZ Point and add another XYZ Point to it

        Parameters

        • xyz: Point3D

          The XYZ Point to add to.

        • point: Point3D

          The XYZ Point to add.

        Returns Point3D

        • The XYZ Point with the added XYZ Point.
        -
      +
    diff --git a/docs/functions/S2Point.distance.html b/docs/functions/S2Point.distance.html index e29ece8..40d1389 100644 --- a/docs/functions/S2Point.distance.html +++ b/docs/functions/S2Point.distance.html @@ -1,7 +1,7 @@ -distance | s2json-spec - v1.4.0
    • Get the distance between two XYZ Points

      +distance | s2json-spec - v1.4.1
      • Get the distance between two XYZ Points

        Parameters

        Returns number

        • The raw distance between the two XYZ Points. Highly inaccurate for large distances
        -
      +
    diff --git a/docs/functions/S2Point.distanceEarth.html b/docs/functions/S2Point.distanceEarth.html index 6a5a049..7207f5f 100644 --- a/docs/functions/S2Point.distanceEarth.html +++ b/docs/functions/S2Point.distanceEarth.html @@ -1,7 +1,7 @@ -distanceEarth | s2json-spec - v1.4.0

    Function distanceEarth

    • Get the distance between two XYZ Points using Earth's size

      +distanceEarth | s2json-spec - v1.4.1

      Function distanceEarth

      • Get the distance between two XYZ Points using Earth's size

        Parameters

        Returns number

        • The distance between the two XYZ Points
        -
      +
    diff --git a/docs/functions/S2Point.fromIJ.html b/docs/functions/S2Point.fromIJ.html index 6354192..e44ae8f 100644 --- a/docs/functions/S2Point.fromIJ.html +++ b/docs/functions/S2Point.fromIJ.html @@ -1,6 +1,6 @@ -fromIJ | s2json-spec - v1.4.0
    • Convert an i-j coordinate to an XYZ Point.

      +fromIJ | s2json-spec - v1.4.1
      • Convert an i-j coordinate to an XYZ Point.

        Parameters

        • face: Face

          The face of the S2 cell.

        • i: number

          The i-coordinate on the face.

        • j: number

          The j-coordinate on the face.

        Returns Point3D

        The XYZ Point representing the given i-j coordinates.

        -
      +
    diff --git a/docs/functions/S2Point.fromLonLat.html b/docs/functions/S2Point.fromLonLat.html index 0f37a91..7922979 100644 --- a/docs/functions/S2Point.fromLonLat.html +++ b/docs/functions/S2Point.fromLonLat.html @@ -1,5 +1,5 @@ -fromLonLat | s2json-spec - v1.4.0

    Function fromLonLat

    • Convert a lon-lat coord to an XYZ Point using the left-hand-rule

      +fromLonLat | s2json-spec - v1.4.1

      Function fromLonLat

      • Convert a lon-lat coord to an XYZ Point using the left-hand-rule

        Parameters

        • lon: number

          The longitude in degrees

        • lat: number

          The latitude in degrees

        Returns Point3D

        The XYZ Point

        -
      +
    diff --git a/docs/functions/S2Point.fromLonLatGL.html b/docs/functions/S2Point.fromLonLatGL.html index 4ae6fa3..64c1b35 100644 --- a/docs/functions/S2Point.fromLonLatGL.html +++ b/docs/functions/S2Point.fromLonLatGL.html @@ -1,6 +1,6 @@ -fromLonLatGL | s2json-spec - v1.4.0

    Function fromLonLatGL

    • Convert a lon-lat coord to an XYZ Point using the right-hand-rule. +fromLonLatGL | s2json-spec - v1.4.1

      Function fromLonLatGL

      • Convert a lon-lat coord to an XYZ Point using the right-hand-rule. This function takes longitude and latitude as input and returns the corresponding XYZ coordinates.

        Parameters

        • lon: number

          The longitude in degrees.

        • lat: number

          The latitude in degrees.

        Returns Point3D

        The XYZ Point representing the provided longitude and latitude.

        -
      +
    diff --git a/docs/functions/S2Point.fromS2CellID.html b/docs/functions/S2Point.fromS2CellID.html index fdd9393..1339666 100644 --- a/docs/functions/S2Point.fromS2CellID.html +++ b/docs/functions/S2Point.fromS2CellID.html @@ -1,4 +1,4 @@ -fromS2CellID | s2json-spec - v1.4.0

    Function fromS2CellID

    • Convert an S2CellID to an XYZ Point.

      +fromS2CellID | s2json-spec - v1.4.1

      Function fromS2CellID

      • Convert an S2CellID to an XYZ Point.

        Parameters

        • id: bigint

          The S2CellID to convert.

        Returns Point3D

        The XYZ Point representing the given S2CellID.

        -
      +
    diff --git a/docs/functions/S2Point.fromST.html b/docs/functions/S2Point.fromST.html index 27b7a63..c796413 100644 --- a/docs/functions/S2Point.fromST.html +++ b/docs/functions/S2Point.fromST.html @@ -1,6 +1,6 @@ -fromST | s2json-spec - v1.4.0
    • Convert an s-t coordinate to an XYZ Point.

      +fromST | s2json-spec - v1.4.1
      • Convert an s-t coordinate to an XYZ Point.

        Parameters

        • face: Face

          The face of the S2 cell.

        • s: number

          The s-coordinate on the face.

        • t: number

          The t-coordinate on the face.

        Returns Point3D

        The XYZ Point representing the given s-t coordinates.

        -
      +
    diff --git a/docs/functions/S2Point.fromSTGL.html b/docs/functions/S2Point.fromSTGL.html index 56f3436..6f9bff2 100644 --- a/docs/functions/S2Point.fromSTGL.html +++ b/docs/functions/S2Point.fromSTGL.html @@ -1,6 +1,6 @@ -fromSTGL | s2json-spec - v1.4.0
    • Convert an Face-S-T coord to an XYZ Point using the right-hand-rule

      +fromSTGL | s2json-spec - v1.4.1
      • Convert an Face-S-T coord to an XYZ Point using the right-hand-rule

        Parameters

        • face: Face

          The face of the S2 cell.

        • s: number

          The s-coordinate on the face.

        • t: number

          The t-coordinate on the face.

        Returns Point3D

        The XYZ Point representing the given Face-S-T coordinates.

        -
      +
    diff --git a/docs/functions/S2Point.fromUV.html b/docs/functions/S2Point.fromUV.html index 0ace46f..7df49d3 100644 --- a/docs/functions/S2Point.fromUV.html +++ b/docs/functions/S2Point.fromUV.html @@ -1,6 +1,6 @@ -fromUV | s2json-spec - v1.4.0
    • Convert a u-v coordinate to an XYZ Point.

      +fromUV | s2json-spec - v1.4.1
      • Convert a u-v coordinate to an XYZ Point.

        Parameters

        • face: Face

          The face of the S2 cell.

        • u: number

          The u-coordinate on the face.

        • v: number

          The v-coordinate on the face.

        Returns Point3D

        The XYZ Point representing the given u-v coordinates.

        -
      +
    diff --git a/docs/functions/S2Point.fromUVGL.html b/docs/functions/S2Point.fromUVGL.html index 9a75878..fbb835c 100644 --- a/docs/functions/S2Point.fromUVGL.html +++ b/docs/functions/S2Point.fromUVGL.html @@ -1,6 +1,6 @@ -fromUVGL | s2json-spec - v1.4.0
    • Convert an Face-U-V coord to an XYZ Point using the right-hand-rule

      +fromUVGL | s2json-spec - v1.4.1
      • Convert an Face-U-V coord to an XYZ Point using the right-hand-rule

        Parameters

        • face: Face

          The face of the S2 cell.

        • u: number

          The u-coordinate on the face.

        • v: number

          The v-coordinate on the face.

        Returns Point3D

        The XYZ Point representing the given Face-U-V coordinates.

        -
      +
    diff --git a/docs/functions/S2Point.getFace.html b/docs/functions/S2Point.getFace.html index 758657c..c62e292 100644 --- a/docs/functions/S2Point.getFace.html +++ b/docs/functions/S2Point.getFace.html @@ -1,6 +1,6 @@ -getFace | s2json-spec - v1.4.0
    • Find the S2 Hilbert Face of the XYZ Point [0, 6)

      +getFace | s2json-spec - v1.4.1
      • Find the S2 Hilbert Face of the XYZ Point [0, 6)

        Parameters

        Returns number

        • The S2 Hilbert Face
        -
      +
    diff --git a/docs/functions/S2Point.length.html b/docs/functions/S2Point.length.html index 64c234f..6f93331 100644 --- a/docs/functions/S2Point.length.html +++ b/docs/functions/S2Point.length.html @@ -1,6 +1,6 @@ -length | s2json-spec - v1.4.0
    • Get the length of the XYZ Point

      +length | s2json-spec - v1.4.1
      • Get the length of the XYZ Point

        Parameters

        Returns number

        • The length of the XYZ Point
        -
      +
    diff --git a/docs/functions/S2Point.mul.html b/docs/functions/S2Point.mul.html index 8ea338b..d461cb7 100644 --- a/docs/functions/S2Point.mul.html +++ b/docs/functions/S2Point.mul.html @@ -1,7 +1,7 @@ -mul | s2json-spec - v1.4.0
    • Take an XYZ Point and multiply each component by n

      +mul | s2json-spec - v1.4.1
      • Take an XYZ Point and multiply each component by n

        Parameters

        • xyz: Point3D

          The XYZ Point to multiply.

        • n: number

          The amount to multiply.

        Returns Point3D

        • The XYZ Point with the multiplied amount.
        -
      +
    diff --git a/docs/functions/S2Point.mulScalar.html b/docs/functions/S2Point.mulScalar.html index 3f639db..36dd14e 100644 --- a/docs/functions/S2Point.mulScalar.html +++ b/docs/functions/S2Point.mulScalar.html @@ -1,7 +1,7 @@ -mulScalar | s2json-spec - v1.4.0

    Function mulScalar

    • Take an XYZ Point and multiply it by another XYZ Point

      +mulScalar | s2json-spec - v1.4.1

      Function mulScalar

      • Take an XYZ Point and multiply it by another XYZ Point

        Parameters

        • xyz: Point3D

          The XYZ Point to multiply.

        • point: Point3D

          The XYZ Point to multiply.

        Returns Point3D

        • The XYZ Point with the multiplied XYZ Point.
        -
      +
    diff --git a/docs/functions/S2Point.normalize.html b/docs/functions/S2Point.normalize.html index a37be33..9a3bb9c 100644 --- a/docs/functions/S2Point.normalize.html +++ b/docs/functions/S2Point.normalize.html @@ -1,6 +1,6 @@ -normalize | s2json-spec - v1.4.0

    Function normalize

    • Take an XYZ Point and divide each component by its length

      +normalize | s2json-spec - v1.4.1

      Function normalize

      • Take an XYZ Point and divide each component by its length

        Parameters

        • xyz: Point3D

          The XYZ Point to divide.

        Returns Point3D

        • The XYZ Point with the divided amount.
        -
      +
    diff --git a/docs/functions/S2Point.sub.html b/docs/functions/S2Point.sub.html index 18eb80d..f884628 100644 --- a/docs/functions/S2Point.sub.html +++ b/docs/functions/S2Point.sub.html @@ -1,7 +1,7 @@ -sub | s2json-spec - v1.4.0
    • Take an XYZ Point and subtract an n from each component

      +sub | s2json-spec - v1.4.1
      • Take an XYZ Point and subtract an n from each component

        Parameters

        • xyz: Point3D

          The XYZ Point to subtract from.

        • n: number

          The amount to subtract.

        Returns Point3D

        • The XYZ Point with the subtracted amount.
        -
      +
    diff --git a/docs/functions/S2Point.subScalar.html b/docs/functions/S2Point.subScalar.html index ed78fab..7f17408 100644 --- a/docs/functions/S2Point.subScalar.html +++ b/docs/functions/S2Point.subScalar.html @@ -1,7 +1,7 @@ -subScalar | s2json-spec - v1.4.0

    Function subScalar

    • Take an XYZ Point and subtract another XYZ Point from it

      +subScalar | s2json-spec - v1.4.1

      Function subScalar

      • Take an XYZ Point and subtract another XYZ Point from it

        Parameters

        • xyz: Point3D

          The XYZ Point to subtract from.

        • point: Point3D

          The XYZ Point to subtract.

        Returns Point3D

        • The XYZ Point with the subtracted XYZ Point.
        -
      +
    diff --git a/docs/functions/S2Point.toIJ.html b/docs/functions/S2Point.toIJ.html index 6c6e183..47b7cc7 100644 --- a/docs/functions/S2Point.toIJ.html +++ b/docs/functions/S2Point.toIJ.html @@ -1,5 +1,5 @@ -toIJ | s2json-spec - v1.4.0
    • Convert an XYZ Point to a Face-I-J coord

      +toIJ | s2json-spec - v1.4.1
      • Convert an XYZ Point to a Face-I-J coord

        Parameters

        • xyz: Point3D

          The XYZ Point to convert.

        • Optionallevel: number

          The zoom level of the result. If not provided, the result will have 30 bits of precision.

        Returns [face: Face, i: number, j: number]

        The Face-I-J coordinates representing the given XYZ Point.

        -
      +
    diff --git a/docs/functions/S2Point.toLonLat.html b/docs/functions/S2Point.toLonLat.html index 4d53da6..0adb209 100644 --- a/docs/functions/S2Point.toLonLat.html +++ b/docs/functions/S2Point.toLonLat.html @@ -1,4 +1,4 @@ -toLonLat | s2json-spec - v1.4.0
    • Convert an XYZ Point to a lon-lat coord

      +toLonLat | s2json-spec - v1.4.1
      • Convert an XYZ Point to a lon-lat coord

        Parameters

        • xyz: Point3D

          The XYZ Point to convert.

        Returns [lon: number, lat: number]

        The lon-lat coordinates representing the given XYZ Point.

        -
      +
    diff --git a/docs/functions/S2Point.toS2CellID.html b/docs/functions/S2Point.toS2CellID.html index a1f8925..e2336e3 100644 --- a/docs/functions/S2Point.toS2CellID.html +++ b/docs/functions/S2Point.toS2CellID.html @@ -1,4 +1,4 @@ -toS2CellID | s2json-spec - v1.4.0

    Function toS2CellID

    • Convert an XYZ Point to an S2CellID

      +toS2CellID | s2json-spec - v1.4.1

      Function toS2CellID

      • Convert an XYZ Point to an S2CellID

        Parameters

        • xyz: Point3D

          The XYZ Point to convert.

        Returns bigint

        The S2CellID representing the given XYZ Point.

        -
      +
    diff --git a/docs/functions/S2Point.toST.html b/docs/functions/S2Point.toST.html index cfcc9f8..806dd83 100644 --- a/docs/functions/S2Point.toST.html +++ b/docs/functions/S2Point.toST.html @@ -1,6 +1,6 @@ -toST | s2json-spec - v1.4.0
    • Convert an XYZ Point to a Face-S-T coord

      +toST | s2json-spec - v1.4.1
      • Convert an XYZ Point to a Face-S-T coord

        Parameters

        • xyz: Point3D

          The XYZ Point to convert.

        Returns [face: Face, s: number, t: number]

        • The Face-S-T coordinates representing the given XYZ Point.
        -
      +
    diff --git a/docs/functions/S2Point.toUV.html b/docs/functions/S2Point.toUV.html index 2e31d3f..e3f053f 100644 --- a/docs/functions/S2Point.toUV.html +++ b/docs/functions/S2Point.toUV.html @@ -1,6 +1,6 @@ -toUV | s2json-spec - v1.4.0
    • Convert an XYZ Point to a Face-U-V coord

      +toUV | s2json-spec - v1.4.1
      • Convert an XYZ Point to a Face-U-V coord

        Parameters

        • xyz: Point3D

          The XYZ Point to convert.

        Returns [face: Face, u: number, v: number]

        • The Face-U-V coordinates representing the given XYZ Point.
        -
      +
    diff --git a/docs/functions/STtoIJ.html b/docs/functions/STtoIJ.html index eccc8a3..c465990 100644 --- a/docs/functions/STtoIJ.html +++ b/docs/functions/STtoIJ.html @@ -1,4 +1,4 @@ -STtoIJ | s2json-spec - v1.4.0

    Function STtoIJ

    • Convert from st space to ij space (ij are whole numbers ranging an entire u30)

      +STtoIJ | s2json-spec - v1.4.1

      Function STtoIJ

      • Convert from st space to ij space (ij are whole numbers ranging an entire u30)

        Parameters

        • s: number

          input S or T

        Returns number

        output I or J

        -
      +
    diff --git a/docs/functions/SiTiToST.html b/docs/functions/SiTiToST.html index 497a461..ee5efbe 100644 --- a/docs/functions/SiTiToST.html +++ b/docs/functions/SiTiToST.html @@ -1,4 +1,4 @@ -SiTiToST | s2json-spec - v1.4.0

    Function SiTiToST

    • Convert SiTi to ST.

      +SiTiToST | s2json-spec - v1.4.1

      Function SiTiToST

      • Convert SiTi to ST.

        Parameters

        • si: number

          input Si or Ti

        Returns number

        output S or T

        -
      +
    diff --git a/docs/functions/XYZtoFace.html b/docs/functions/XYZtoFace.html index d525186..ae09c05 100644 --- a/docs/functions/XYZtoFace.html +++ b/docs/functions/XYZtoFace.html @@ -1,6 +1,6 @@ -XYZtoFace | s2json-spec - v1.4.0

    Function XYZtoFace

    • Find the face the point is located at

      +XYZtoFace | s2json-spec - v1.4.1

      Function XYZtoFace

      • Find the face the point is located at

        Parameters

        Returns Face

        • outputs the associated face
        -
      +
    diff --git a/docs/functions/XYZtoFaceUV.html b/docs/functions/XYZtoFaceUV.html index 2c99584..4c40d97 100644 --- a/docs/functions/XYZtoFaceUV.html +++ b/docs/functions/XYZtoFaceUV.html @@ -1,4 +1,4 @@ -XYZtoFaceUV | s2json-spec - v1.4.0

    Function XYZtoFaceUV

    • Convert from an left-hand-rule XYZ Point to a Face-U-V coordinate

      +XYZtoFaceUV | s2json-spec - v1.4.1

      Function XYZtoFaceUV

      • Convert from an left-hand-rule XYZ Point to a Face-U-V coordinate

        Parameters

        Returns [face: Face, u: number, v: number]

        output's a face, u, and v

        -
      +
    diff --git a/docs/functions/bboxOverlap.html b/docs/functions/bboxOverlap.html index e1ae150..0a631e2 100644 --- a/docs/functions/bboxOverlap.html +++ b/docs/functions/bboxOverlap.html @@ -1,8 +1,8 @@ -bboxOverlap | s2json-spec - v1.4.0

    Function bboxOverlap

    • Checks if two bounding boxes overlap. If they don't overlap, returns undefined. +bboxOverlap | s2json-spec - v1.4.1

      Function bboxOverlap

      • Checks if two bounding boxes overlap. If they don't overlap, returns undefined. If they do, return the overlap

        Parameters

        • b1: BBox

          first bounding box

        • b2: BBox

          second bounding box

        Returns undefined | BBox

        • undefined if no overlap, or a bbox of the overlap
        -
      +
    diff --git a/docs/functions/bboxST.html b/docs/functions/bboxST.html index f4265e8..511ef22 100644 --- a/docs/functions/bboxST.html +++ b/docs/functions/bboxST.html @@ -1,8 +1,8 @@ -bboxST | s2json-spec - v1.4.0

    Function bboxST

    • Given a quad-based tile schema of "zoom-x-y", get the local ST bounds of said tile.

      +bboxST | s2json-spec - v1.4.1

      Function bboxST

      • Given a quad-based tile schema of "zoom-x-y", get the local ST bounds of said tile.

        Parameters

        • s: number

          s coordinate

        • t: number

          t coordinate

        • zoom: number

          zoom level

        Returns BBox

        • local ST bounds for the tile
        -
      +
    diff --git a/docs/functions/bboxUV.html b/docs/functions/bboxUV.html index 226578c..fcd558d 100644 --- a/docs/functions/bboxUV.html +++ b/docs/functions/bboxUV.html @@ -1,8 +1,8 @@ -bboxUV | s2json-spec - v1.4.0

    Function bboxUV

    • Given a quad-based tile schema of "zoom-x-y", get the local UV bounds of said tile.

      +bboxUV | s2json-spec - v1.4.1

      Function bboxUV

      • Given a quad-based tile schema of "zoom-x-y", get the local UV bounds of said tile.

        Parameters

        • u: number

          u coordinate

        • v: number

          v coordinate

        • zoom: number

          zoom level

        Returns BBox

        • local UV bounds for the tile
        -
      +
    diff --git a/docs/functions/buildSqDist.html b/docs/functions/buildSqDist.html index b6f4f86..1ecd609 100644 --- a/docs/functions/buildSqDist.html +++ b/docs/functions/buildSqDist.html @@ -1,7 +1,7 @@ -buildSqDist | s2json-spec - v1.4.0

    Function buildSqDist

    • calculate simplification of line vector data using +buildSqDist | s2json-spec - v1.4.1

      Function buildSqDist

      • calculate simplification of line vector data using optimized Douglas-Peucker algorithm

        Parameters

        • coords: VectorLineString

          input coordinates

        • first: number

          first point index

        • last: number

          last points index

        • sqTolerance: number

          simplification tolerance (higher means simpler)

          -

        Returns void

      +

    Returns void

    diff --git a/docs/functions/buildSqDists.html b/docs/functions/buildSqDists.html index 89c493b..0942bbe 100644 --- a/docs/functions/buildSqDists.html +++ b/docs/functions/buildSqDists.html @@ -1,4 +1,4 @@ -buildSqDists | s2json-spec - v1.4.0

    Function buildSqDists

    • Parameters

      • geometry: VectorGeometry

        input vector geometry

        +buildSqDists | s2json-spec - v1.4.1

        Function buildSqDists

        • Parameters

          • geometry: VectorGeometry

            input vector geometry

          • tolerance: number

            simplification tolerance

          • maxzoom: number = 16

            max zoom level to simplify

            -

          Returns void

        +

      Returns void

    diff --git a/docs/functions/childrenIJ.html b/docs/functions/childrenIJ.html index 7f6fe73..bafb6f5 100644 --- a/docs/functions/childrenIJ.html +++ b/docs/functions/childrenIJ.html @@ -1,4 +1,4 @@ -childrenIJ | s2json-spec - v1.4.0

    Function childrenIJ

    • Given the projection, get the children tiles given the face-zoom-i-j.

      +childrenIJ | s2json-spec - v1.4.1

      Function childrenIJ

      • Given the projection, get the children tiles given the face-zoom-i-j.

        Parameters

        • proj: Projection

          the projection

        • face: Face

          the face

        • zoom: number

          the zoom

          @@ -7,4 +7,4 @@

        Returns [blID: bigint, brID: bigint, tlID: bigint, trID: bigint]

        • the tile IDs of the children
        -
      +
    diff --git a/docs/functions/clipBBox.html b/docs/functions/clipBBox.html index 2e53e89..800c1da 100644 --- a/docs/functions/clipBBox.html +++ b/docs/functions/clipBBox.html @@ -1,7 +1,7 @@ -clipBBox | s2json-spec - v1.4.0

    Function clipBBox

    • Create a new bounding box clipped by the axis and min-max

      +clipBBox | s2json-spec - v1.4.1

      Function clipBBox

      • Create a new bounding box clipped by the axis and min-max

        Parameters

        • bb: undefined | BBOX

          the original bounding box

        • axis: 0 | 1

          0 for x, 1 for y

        • k1: number

          the lower bound

        • k2: number

          the upper bound

        Returns BBOX

        the new bounding box clipped by the axis and min-max

        -
      +
    diff --git a/docs/functions/contains.html b/docs/functions/contains.html index 3ad6faa..8417935 100644 --- a/docs/functions/contains.html +++ b/docs/functions/contains.html @@ -1,8 +1,8 @@ -contains | s2json-spec - v1.4.0

    Function contains

    • Given the projection, check if the "child" exists inside the "parent"'s bounds or not.

      +contains | s2json-spec - v1.4.1

      Function contains

      • Given the projection, check if the "child" exists inside the "parent"'s bounds or not.

        Parameters

        • proj: Projection

          the projection

        • parentID: bigint

          the parent

        • childID: bigint

          the child

        Returns boolean

        • true if the "child" exists inside the "parent"'s bounds
        -
      +
    diff --git a/docs/functions/degToRad.html b/docs/functions/degToRad.html index 6adca7d..9c97009 100644 --- a/docs/functions/degToRad.html +++ b/docs/functions/degToRad.html @@ -1,4 +1,4 @@ -degToRad | s2json-spec - v1.4.0

    Function degToRad

    • convert degrees to radians

      +degToRad | s2json-spec - v1.4.1

      Function degToRad

      • convert degrees to radians

        Parameters

        • deg: number

          degree value

        Returns number

        radians

        -
      +
    diff --git a/docs/functions/extendBBox.html b/docs/functions/extendBBox.html index 35d3290..b56cbaa 100644 --- a/docs/functions/extendBBox.html +++ b/docs/functions/extendBBox.html @@ -1,6 +1,6 @@ -extendBBox | s2json-spec - v1.4.0

    Function extendBBox

    • Parameters

      • bbox: undefined | BBOX

        the bounding box to extend, if it doesn't exist it will be created otherwise just modified

        +extendBBox | s2json-spec - v1.4.1

        Function extendBBox

        • Parameters

          • bbox: undefined | BBOX

            the bounding box to extend, if it doesn't exist it will be created otherwise just modified

          • point: VectorPoint

            the point to add to the bbox

          Returns BBOX

          • the extended bbox
          -
        +
    diff --git a/docs/functions/face-1.html b/docs/functions/face-1.html index 95aa9ee..46058d9 100644 --- a/docs/functions/face-1.html +++ b/docs/functions/face-1.html @@ -1,7 +1,7 @@ -face | s2json-spec - v1.4.0

    Function face

    • Given the projection, get the face of the input ID. If not S2, gaurenteed to be 0.

      +face | s2json-spec - v1.4.1

      Function face

      • Given the projection, get the face of the input ID. If not S2, gaurenteed to be 0.

        Parameters

        • proj: Projection

          the projection

        • id: bigint

          the input tile ID

        Returns Face

        • the tile ID of the parent
        -
      +
    diff --git a/docs/functions/faceUVtoXYZ.html b/docs/functions/faceUVtoXYZ.html index 5708f64..f1c94e0 100644 --- a/docs/functions/faceUVtoXYZ.html +++ b/docs/functions/faceUVtoXYZ.html @@ -1,6 +1,6 @@ -faceUVtoXYZ | s2json-spec - v1.4.0

    Function faceUVtoXYZ

    • Convert a face-u-v coords to left-hand-rule XYZ Point coords

      +faceUVtoXYZ | s2json-spec - v1.4.1

      Function faceUVtoXYZ

      • Convert a face-u-v coords to left-hand-rule XYZ Point coords

        Parameters

        • face: Face

          input face

        • u: number

          input u

        • v: number

          input v

        Returns Point3D

        output

        -
      +
    diff --git a/docs/functions/faceUVtoXYZGL.html b/docs/functions/faceUVtoXYZGL.html index 0e17b55..1028ba4 100644 --- a/docs/functions/faceUVtoXYZGL.html +++ b/docs/functions/faceUVtoXYZGL.html @@ -1,6 +1,6 @@ -faceUVtoXYZGL | s2json-spec - v1.4.0

    Function faceUVtoXYZGL

    • Convert a face-u-v coords to right-hand-rule XYZ Point coords

      +faceUVtoXYZGL | s2json-spec - v1.4.1

      Function faceUVtoXYZGL

      • Convert a face-u-v coords to right-hand-rule XYZ Point coords

        Parameters

        • face: Face

          input face

        • u: number

          input u

        • v: number

          input v

        Returns Point3D

        output

        -
      +
    diff --git a/docs/functions/faceXYZGLtoUV.html b/docs/functions/faceXYZGLtoUV.html index 62af08d..570d116 100644 --- a/docs/functions/faceXYZGLtoUV.html +++ b/docs/functions/faceXYZGLtoUV.html @@ -1,5 +1,5 @@ -faceXYZGLtoUV | s2json-spec - v1.4.0

    Function faceXYZGLtoUV

    • Convert from a face and right-hand-rule XYZ Point to u-v coords

      +faceXYZGLtoUV | s2json-spec - v1.4.1

      Function faceXYZGLtoUV

      • Convert from a face and right-hand-rule XYZ Point to u-v coords

        Parameters

        • face: number

          input face

        • xyz: Point3D

          input Point3D

        Returns [u: number, v: number]

        output WebGL oriented UV coords

        -
      +
    diff --git a/docs/functions/faceXYZtoUV.html b/docs/functions/faceXYZtoUV.html index d079b5b..2ab62a9 100644 --- a/docs/functions/faceXYZtoUV.html +++ b/docs/functions/faceXYZtoUV.html @@ -1,5 +1,5 @@ -faceXYZtoUV | s2json-spec - v1.4.0

    Function faceXYZtoUV

    • Convert from a face and left-hand-rule XYZ Point to u-v coords

      +faceXYZtoUV | s2json-spec - v1.4.1

      Function faceXYZtoUV

      • Convert from a face and left-hand-rule XYZ Point to u-v coords

        Parameters

        Returns [u: number, v: number]

        output

        -
      +
    diff --git a/docs/functions/fromFace.html b/docs/functions/fromFace.html index 772f2a3..3a15a6e 100644 --- a/docs/functions/fromFace.html +++ b/docs/functions/fromFace.html @@ -1,7 +1,7 @@ -fromFace | s2json-spec - v1.4.0

    Function fromFace

    • Given the projection, get the ID of a requested face. If not S2, gaurenteed to be 0.

      +fromFace | s2json-spec - v1.4.1

      Function fromFace

      • Given the projection, get the ID of a requested face. If not S2, gaurenteed to be 0.

        Parameters

        Returns bigint

        • the ID of the requested face
        -
      +
    diff --git a/docs/functions/fromID.html b/docs/functions/fromID.html index 4c02f73..c9ad2f6 100644 --- a/docs/functions/fromID.html +++ b/docs/functions/fromID.html @@ -1,6 +1,6 @@ -fromID | s2json-spec - v1.4.0

    Function fromID

    • Parameters

      • proj: Projection

        the projection of choice

        +fromID | s2json-spec - v1.4.1

        Function fromID

        • Parameters

          • proj: Projection

            the projection of choice

          • id: bigint

            the tile ID

          Returns [face: Face, zoom: number, i: number, j: number]

          • the tile broken into face-zoom-i-j
          -
        +
    diff --git a/docs/functions/fromPoint.html b/docs/functions/fromPoint.html index 1491c27..a721307 100644 --- a/docs/functions/fromPoint.html +++ b/docs/functions/fromPoint.html @@ -1,5 +1,5 @@ -fromPoint | s2json-spec - v1.4.0

    Function fromPoint

    • Parameters

      • point: VectorPoint

        input vector point

        +fromPoint | s2json-spec - v1.4.1

        Function fromPoint

        • Parameters

          Returns BBOX

          • BBox of the point
          -
        +
    diff --git a/docs/functions/isFace.html b/docs/functions/isFace.html index e42b775..0f03dca 100644 --- a/docs/functions/isFace.html +++ b/docs/functions/isFace.html @@ -1,7 +1,7 @@ -isFace | s2json-spec - v1.4.0

    Function isFace

    • Given the projection, check if the tile ID is of the highest zoom or not.

      +isFace | s2json-spec - v1.4.1

      Function isFace

      • Given the projection, check if the tile ID is of the highest zoom or not.

        Parameters

        • proj: Projection

          the projection

        • id: bigint

          the input tile ID

        Returns boolean

        • true if the tile ID is of the highest zoom
        -
      +
    diff --git a/docs/functions/level.html b/docs/functions/level.html index abbedf7..738f1c2 100644 --- a/docs/functions/level.html +++ b/docs/functions/level.html @@ -1,7 +1,7 @@ -level | s2json-spec - v1.4.0

    Function level

    • Given the projection and tile ID, get the zoom of said tile.

      +level | s2json-spec - v1.4.1

      Function level

      • Given the projection and tile ID, get the zoom of said tile.

        Parameters

        • proj: Projection

          the projection

        • id: bigint

          the input tile ID

        Returns number

        • the zoom of the tile
        -
      +
    diff --git a/docs/functions/linearSTtoUV.html b/docs/functions/linearSTtoUV.html index 2993a5e..9af3c2d 100644 --- a/docs/functions/linearSTtoUV.html +++ b/docs/functions/linearSTtoUV.html @@ -1,4 +1,4 @@ -linearSTtoUV | s2json-spec - v1.4.0

    Function linearSTtoUV

    • Convert a [0, 1] to a [-1, 1] in a linear fashion

      +linearSTtoUV | s2json-spec - v1.4.1

      Function linearSTtoUV

      • Convert a [0, 1] to a [-1, 1] in a linear fashion

        Parameters

        • s: number

          input S or T coordinate

        Returns number

        output U or V coordinate

        -
      +
    diff --git a/docs/functions/linearUVtoST.html b/docs/functions/linearUVtoST.html index 48bc52c..5182813 100644 --- a/docs/functions/linearUVtoST.html +++ b/docs/functions/linearUVtoST.html @@ -1,4 +1,4 @@ -linearUVtoST | s2json-spec - v1.4.0

    Function linearUVtoST

    • Convert a [-1, 1] to a [0, 1] in a linear fashion

      +linearUVtoST | s2json-spec - v1.4.1

      Function linearUVtoST

      • Convert a [-1, 1] to a [0, 1] in a linear fashion

        Parameters

        • u: number

          input U or V coordinate

        Returns number

        output S or T coordinate

        -
      +
    diff --git a/docs/functions/lonLatToXYZ.html b/docs/functions/lonLatToXYZ.html index 68a7692..2c06263 100644 --- a/docs/functions/lonLatToXYZ.html +++ b/docs/functions/lonLatToXYZ.html @@ -1,7 +1,7 @@ -lonLatToXYZ | s2json-spec - v1.4.0

    Function lonLatToXYZ

    • Convert from a lon-lat coord to an left-hand-rule XYZ Point

      +lonLatToXYZ | s2json-spec - v1.4.1

      Function lonLatToXYZ

      • Convert from a lon-lat coord to an left-hand-rule XYZ Point

        Parameters

        • lon: number

          longitude

        • lat: number

          latitude

        Returns Point3D

        • Point3D
        -
      +
    diff --git a/docs/functions/lonLatToXYZGL.html b/docs/functions/lonLatToXYZGL.html index 8fb287e..1e86ea3 100644 --- a/docs/functions/lonLatToXYZGL.html +++ b/docs/functions/lonLatToXYZGL.html @@ -1,7 +1,7 @@ -lonLatToXYZGL | s2json-spec - v1.4.0

    Function lonLatToXYZGL

    • Convert from a lon-lat coord to an right-hand-rule XYZ Point

      +lonLatToXYZGL | s2json-spec - v1.4.1

      Function lonLatToXYZGL

      • Convert from a lon-lat coord to an right-hand-rule XYZ Point

        Parameters

        • lon: number

          longitude

        • lat: number

          latitude

        Returns Point3D

        • WebGL oriented Point3D
        -
      +
    diff --git a/docs/functions/mercID.children.html b/docs/functions/mercID.children.html index 69636d9..31522e4 100644 --- a/docs/functions/mercID.children.html +++ b/docs/functions/mercID.children.html @@ -1,6 +1,6 @@ -children | s2json-spec - v1.4.0

    Function children

    • Given a tile ID, find the 4 children tile IDs

      +children | s2json-spec - v1.4.1

      Function children

      • Given a tile ID, find the 4 children tile IDs

        Parameters

        • id: bigint

          the tile ID

        Returns [blID: bigint, brID: bigint, tlID: bigint, trID: bigint]

        • 4 tile IDs of the children associated with the tile
        -
      +
    diff --git a/docs/functions/mercID.contains.html b/docs/functions/mercID.contains.html index 53584a3..0d7af4b 100644 --- a/docs/functions/mercID.contains.html +++ b/docs/functions/mercID.contains.html @@ -1,7 +1,7 @@ -contains | s2json-spec - v1.4.0

    Function contains

    • Check if the parentID contains the childID within the sub quads

      +contains | s2json-spec - v1.4.1

      Function contains

      • Check if the parentID contains the childID within the sub quads

        Parameters

        • parentID: bigint

          the parent ID

        • childID: bigint

          the child ID

        Returns boolean

        • true if the parent contains the child
        -
      +
    diff --git a/docs/functions/mercID.fromID.html b/docs/functions/mercID.fromID.html index bdd49c6..f3a3782 100644 --- a/docs/functions/mercID.fromID.html +++ b/docs/functions/mercID.fromID.html @@ -1,6 +1,6 @@ -fromID | s2json-spec - v1.4.0
    • Convert a number or bigint to [zoom, x, y]

      +fromID | s2json-spec - v1.4.1
      • Convert a number or bigint to [zoom, x, y]

        Parameters

        • idB: bigint

          the tile ID

        Returns [zoom: number, x: number, y: number]

        • tile coordinates
        -
      +
    diff --git a/docs/functions/mercID.isFace.html b/docs/functions/mercID.isFace.html index d8d88a2..c8f6e6b 100644 --- a/docs/functions/mercID.isFace.html +++ b/docs/functions/mercID.isFace.html @@ -1,6 +1,6 @@ -isFace | s2json-spec - v1.4.0
    • Given a Tile ID, check if the zoom is 0 or not

      +isFace | s2json-spec - v1.4.1
      • Given a Tile ID, check if the zoom is 0 or not

        Parameters

        • id: bigint

          the tile ID

        Returns boolean

        • true if the zoom is 0
        -
      +
    diff --git a/docs/functions/mercID.isOutOfBounds.html b/docs/functions/mercID.isOutOfBounds.html index 0c2e510..6a4477f 100644 --- a/docs/functions/mercID.isOutOfBounds.html +++ b/docs/functions/mercID.isOutOfBounds.html @@ -1,8 +1,8 @@ -isOutOfBounds | s2json-spec - v1.4.0

    Function isOutOfBounds

    • Check if the tile is not a real world tile that fits inside the quad tree +isOutOfBounds | s2json-spec - v1.4.1

      Function isOutOfBounds

      • Check if the tile is not a real world tile that fits inside the quad tree Out of bounds tiles exist if the map has duplicateHorizontally set to true. This is useful for filling in the canvas on the x axis instead of leaving it blank.

        Parameters

        • id: bigint

          the tile ID

        Returns boolean

        • true if the tile is out of bounds
        -
      +
    diff --git a/docs/functions/mercID.level.html b/docs/functions/mercID.level.html index 661e918..b88ae6a 100644 --- a/docs/functions/mercID.level.html +++ b/docs/functions/mercID.level.html @@ -1,6 +1,6 @@ -level | s2json-spec - v1.4.0
    • Get the zoom from the tile ID

      +level | s2json-spec - v1.4.1
      • Get the zoom from the tile ID

        Parameters

        • id: bigint

          the tile ID

        Returns number

        • the zoom
        -
      +
    diff --git a/docs/functions/mercID.neighborsXY.html b/docs/functions/mercID.neighborsXY.html index 66022bb..ad1a2b6 100644 --- a/docs/functions/mercID.neighborsXY.html +++ b/docs/functions/mercID.neighborsXY.html @@ -1,4 +1,4 @@ -neighborsXY | s2json-spec - v1.4.0

    Function neighborsXY

    • grab the tiles next to the current tiles zoom-x-y +neighborsXY | s2json-spec - v1.4.1

      Function neighborsXY

      • grab the tiles next to the current tiles zoom-x-y only include adjacent tiles, not diagonal. If includeOutOfBounds set to true, it will include out of bounds tiles on the x-axis

        @@ -9,4 +9,4 @@

      Returns [zoom: number, x: number, y: number][]

      • list of adjacent tiles
      -
    +
    diff --git a/docs/functions/mercID.parent.html b/docs/functions/mercID.parent.html index 30119f0..147736c 100644 --- a/docs/functions/mercID.parent.html +++ b/docs/functions/mercID.parent.html @@ -1,6 +1,6 @@ -parent | s2json-spec - v1.4.0
    • Given a tileID, find the parent tile

      +parent | s2json-spec - v1.4.1
      • Given a tileID, find the parent tile

        Parameters

        • id: bigint

          the tile ID

        Returns bigint

        • the parent tile
        -
      +
    diff --git a/docs/functions/mercID.tileIDWrapped.html b/docs/functions/mercID.tileIDWrapped.html index 4e62070..6d64ceb 100644 --- a/docs/functions/mercID.tileIDWrapped.html +++ b/docs/functions/mercID.tileIDWrapped.html @@ -1,4 +1,4 @@ -tileIDWrapped | s2json-spec - v1.4.0

    Function tileIDWrapped

    • Given a tile ID, find the "wrapped" tile ID. +tileIDWrapped | s2json-spec - v1.4.1

      Function tileIDWrapped

      • Given a tile ID, find the "wrapped" tile ID. It may resolve to itself. This is useful for maps that have duplicateHorizontally set to true. It forces the tile to be within the bounds of the quad tree.

        @@ -6,4 +6,4 @@

      Returns bigint

      • the wrapped tile ID
      -
    +
    diff --git a/docs/functions/mercID.toID.html b/docs/functions/mercID.toID.html index 7c765c6..42cc2b9 100644 --- a/docs/functions/mercID.toID.html +++ b/docs/functions/mercID.toID.html @@ -1,8 +1,8 @@ -toID | s2json-spec - v1.4.0
    • Convert zoom-x-y to a singular number

      +toID | s2json-spec - v1.4.1
      • Convert zoom-x-y to a singular number

        Parameters

        • zoom: number

          zoom level

        • x: number

          x coord

        • y: number

          y coord

        Returns bigint

        • The ID associated with the tile
        -
      +
    diff --git a/docs/functions/mercID.toIJ.html b/docs/functions/mercID.toIJ.html index 0543d20..fe1fa8d 100644 --- a/docs/functions/mercID.toIJ.html +++ b/docs/functions/mercID.toIJ.html @@ -1,7 +1,7 @@ -toIJ | s2json-spec - v1.4.0
    • convert an id to a zoom-x-y after setting it to a new parent zoom

      +toIJ | s2json-spec - v1.4.1
      • convert an id to a zoom-x-y after setting it to a new parent zoom

        Parameters

        • id: bigint

          the tile ID

        • Optionallevel: number | bigint

          the new zoom level (if not set, it will be the same as the old zoom level)

        Returns [zoom: number, x: number, y: number]

        • the new zoom-x-y
        -
      +
    diff --git a/docs/functions/mergeBBoxes.html b/docs/functions/mergeBBoxes.html index 3ed8ec5..20be6ee 100644 --- a/docs/functions/mergeBBoxes.html +++ b/docs/functions/mergeBBoxes.html @@ -1,7 +1,7 @@ -mergeBBoxes | s2json-spec - v1.4.0

    Function mergeBBoxes

    • Merges two bounding boxes into the first and returns the result

      +mergeBBoxes | s2json-spec - v1.4.1

      Function mergeBBoxes

      • Merges two bounding boxes into the first and returns the result

        Parameters

        • b1: BBOX

          the first bounding box

        • b2: BBOX

          the second bounding box

        Returns BBOX

        • the merged bounding box
        -
      +
    diff --git a/docs/functions/neighborsIJ.html b/docs/functions/neighborsIJ.html index 0db9c3c..852c382 100644 --- a/docs/functions/neighborsIJ.html +++ b/docs/functions/neighborsIJ.html @@ -1,4 +1,4 @@ -neighborsIJ | s2json-spec - v1.4.0

    Function neighborsIJ

    • Find the face-i-j coordinates of neighbors for a specific face-i-j coordinate. +neighborsIJ | s2json-spec - v1.4.1

      Function neighborsIJ

      • Find the face-i-j coordinates of neighbors for a specific face-i-j coordinate. Define an adjusted level (zoom) for the i-j coordinates. The level is 30 by default.

        Parameters

        • face: Face

          face of the cell

        • i: number

          i coordinate

          @@ -7,4 +7,4 @@

        Returns [face: Face, i: number, j: number][]

        • Face-i-j coordinates
        -
      +
    diff --git a/docs/functions/parent.html b/docs/functions/parent.html index 9280e5b..ccf6807 100644 --- a/docs/functions/parent.html +++ b/docs/functions/parent.html @@ -1,7 +1,7 @@ -parent | s2json-spec - v1.4.0

    Function parent

    • Given the projection, get the parent tile of the input ID

      +parent | s2json-spec - v1.4.1

      Function parent

      • Given the projection, get the parent tile of the input ID

        Parameters

        • proj: Projection

          the projection

        • id: bigint

          the input tile ID

        Returns bigint

        • the tile ID of the parent
        -
      +
    diff --git a/docs/functions/pointOverlap.html b/docs/functions/pointOverlap.html index 2b18072..52020cf 100644 --- a/docs/functions/pointOverlap.html +++ b/docs/functions/pointOverlap.html @@ -1,7 +1,7 @@ -pointOverlap | s2json-spec - v1.4.0

    Function pointOverlap

    • Checks if a point is within a bounding box

      +pointOverlap | s2json-spec - v1.4.1

      Function pointOverlap

      • Checks if a point is within a bounding box

        Parameters

        • bbox: BBox

          the bounding box to test

        • point: VectorPoint

          point to test if it exists within the bbox

        Returns boolean

        • true if the point is within the bbox, false otherwise
        -
      +
    diff --git a/docs/functions/quadraticSTtoUV.html b/docs/functions/quadraticSTtoUV.html index de63f04..1561e71 100644 --- a/docs/functions/quadraticSTtoUV.html +++ b/docs/functions/quadraticSTtoUV.html @@ -1,4 +1,4 @@ -quadraticSTtoUV | s2json-spec - v1.4.0

    Function quadraticSTtoUV

    • Convert a [0, 1] to a [-1, 1] in a quadratic fashion

      +quadraticSTtoUV | s2json-spec - v1.4.1

      Function quadraticSTtoUV

      • Convert a [0, 1] to a [-1, 1] in a quadratic fashion

        Parameters

        • s: number

          input S or T coordinate

        Returns number

        output U or V coordinate

        -
      +
    diff --git a/docs/functions/quadraticUVtoST.html b/docs/functions/quadraticUVtoST.html index a793c0f..47a0827 100644 --- a/docs/functions/quadraticUVtoST.html +++ b/docs/functions/quadraticUVtoST.html @@ -1,4 +1,4 @@ -quadraticUVtoST | s2json-spec - v1.4.0

    Function quadraticUVtoST

    • Convert a [-1, 1] to a [0, 1] in a quadratic fashion

      +quadraticUVtoST | s2json-spec - v1.4.1

      Function quadraticUVtoST

      • Convert a [-1, 1] to a [0, 1] in a quadratic fashion

        Parameters

        • u: number

          input U or V coordinate

        Returns number

        output S or T coordinate

        -
      +
    diff --git a/docs/functions/radToDeg.html b/docs/functions/radToDeg.html index 9da6273..ead09c2 100644 --- a/docs/functions/radToDeg.html +++ b/docs/functions/radToDeg.html @@ -1,4 +1,4 @@ -radToDeg | s2json-spec - v1.4.0

    Function radToDeg

    • convert radians to degrees

      +radToDeg | s2json-spec - v1.4.1

      Function radToDeg

      • convert radians to degrees

        Parameters

        • radians: number

          radian value

        Returns number

        degrees

        -
      +
    diff --git a/docs/functions/rewind.html b/docs/functions/rewind.html index b9f567a..5295803 100644 --- a/docs/functions/rewind.html +++ b/docs/functions/rewind.html @@ -1,4 +1,4 @@ -rewind | s2json-spec - v1.4.0

    Function rewind

    • In place adjust the ring if necessary

      +rewind | s2json-spec - v1.4.1

      Function rewind

      • In place adjust the ring if necessary

        Parameters

        • ring: VectorLineString

          the ring to rewind

        • clockwise: boolean

          whether the ring needs to be clockwise

          -

        Returns void

      +

    Returns void

    diff --git a/docs/functions/simplify.html b/docs/functions/simplify.html index df9d861..bd54bde 100644 --- a/docs/functions/simplify.html +++ b/docs/functions/simplify.html @@ -1,5 +1,5 @@ -simplify | s2json-spec - v1.4.0

    Function simplify

    • Parameters

      • geometry: VectorGeometry

        input vector geometry

        +simplify | s2json-spec - v1.4.1

        Function simplify

        • Parameters

          • geometry: VectorGeometry

            input vector geometry

          • tolerance: number

            simplification tolerance

          • zoom: number

            curent zoom

          • maxzoom: number = 16

            max zoom level

            -

          Returns void

        +

      Returns void

    diff --git a/docs/functions/tanSTtoUV.html b/docs/functions/tanSTtoUV.html index 3e54865..ef2f4bd 100644 --- a/docs/functions/tanSTtoUV.html +++ b/docs/functions/tanSTtoUV.html @@ -1,4 +1,4 @@ -tanSTtoUV | s2json-spec - v1.4.0

    Function tanSTtoUV

    • Convert a [0, 1] to a [-1, 1] in a tangential fashion

      +tanSTtoUV | s2json-spec - v1.4.1

      Function tanSTtoUV

      • Convert a [0, 1] to a [-1, 1] in a tangential fashion

        Parameters

        • s: number

          input S or T coordinate

        Returns number

        output U or V coordinate

        -
      +
    diff --git a/docs/functions/tanUVtoST.html b/docs/functions/tanUVtoST.html index adc996d..4fa0f69 100644 --- a/docs/functions/tanUVtoST.html +++ b/docs/functions/tanUVtoST.html @@ -1,4 +1,4 @@ -tanUVtoST | s2json-spec - v1.4.0

    Function tanUVtoST

    • Convert a [-1, 1] to a [0, 1] in a tangential fashion

      +tanUVtoST | s2json-spec - v1.4.1

      Function tanUVtoST

      • Convert a [-1, 1] to a [0, 1] in a tangential fashion

        Parameters

        • u: number

          input U or V coordinate

        Returns number

        output S or T coordinate

        -
      +
    diff --git a/docs/functions/tileXYFromSTZoom.html b/docs/functions/tileXYFromSTZoom.html index e56dc9f..aa064fb 100644 --- a/docs/functions/tileXYFromSTZoom.html +++ b/docs/functions/tileXYFromSTZoom.html @@ -1,8 +1,8 @@ -tileXYFromSTZoom | s2json-spec - v1.4.0

    Function tileXYFromSTZoom

    • Convert an x-y-zoom coordinate to a tile coordinate

      +tileXYFromSTZoom | s2json-spec - v1.4.1

      Function tileXYFromSTZoom

      • Convert an x-y-zoom coordinate to a tile coordinate

        Parameters

        • x: number

          x coordinate

        • y: number

          y coordinate

        • zoom: number

          zoom level

        Returns Point

        • tile X-Y coordinate
        -
      +
    diff --git a/docs/functions/tileXYFromUVZoom.html b/docs/functions/tileXYFromUVZoom.html index 1ec5b15..52353b3 100644 --- a/docs/functions/tileXYFromUVZoom.html +++ b/docs/functions/tileXYFromUVZoom.html @@ -1,8 +1,8 @@ -tileXYFromUVZoom | s2json-spec - v1.4.0

    Function tileXYFromUVZoom

    • Convert an u-v-zoom coordinate to a tile coordinate

      +tileXYFromUVZoom | s2json-spec - v1.4.1

      Function tileXYFromUVZoom

      • Convert an u-v-zoom coordinate to a tile coordinate

        Parameters

        • u: number

          u coordinate

        • v: number

          v coordinate

        • zoom: number

          zoom level

        Returns Point

        • tile X-Y coordinate
        -
      +
    diff --git a/docs/functions/toIJ.html b/docs/functions/toIJ.html index 78493a8..72a2bcf 100644 --- a/docs/functions/toIJ.html +++ b/docs/functions/toIJ.html @@ -1,8 +1,8 @@ -toIJ | s2json-spec - v1.4.0

    Function toIJ

    • Given the projection and id, return the face/zoom with the i-j coordinate pair

      +toIJ | s2json-spec - v1.4.1

      Function toIJ

      • Given the projection and id, return the face/zoom with the i-j coordinate pair

        Parameters

        • proj: Projection

          the projection

        • id: bigint

          the input tile ID

        • Optionallevel: number | bigint

          the requested zoom

        Returns [faceOrZoom: number, i: number, j: number]

        • the ID of the requested zoom
        -
      +
    diff --git a/docs/functions/toLL.html b/docs/functions/toLL.html index f31bc5f..47f05cc 100644 --- a/docs/functions/toLL.html +++ b/docs/functions/toLL.html @@ -1,3 +1,3 @@ -toLL | s2json-spec - v1.4.0

    Function toLL

    • Reproject GeoJSON geometry coordinates from 0->1 coordinate system to lon-lat in place

      +toLL | s2json-spec - v1.4.1

      Function toLL

      • Reproject GeoJSON geometry coordinates from 0->1 coordinate system to lon-lat in place

        Parameters

        Returns void

      +

    Returns void

    diff --git a/docs/functions/toS2.html b/docs/functions/toS2.html index b0f4a11..845a36e 100644 --- a/docs/functions/toS2.html +++ b/docs/functions/toS2.html @@ -1,8 +1,8 @@ -toS2 | s2json-spec - v1.4.0

    Function toS2

    • Convet a GeoJSON Feature to an S2Feature

      +toS2 | s2json-spec - v1.4.1

      Function toS2

      • Convet a GeoJSON Feature to an S2Feature

        Parameters

        • data: VectorFeature | Feature

          GeoJSON Feature

        • Optionaltolerance: number

          optional tolerance

        • Optionalmaxzoom: number

          optional maxzoom

        Returns S2Feature[]

        • S2Feature
        -
      +
    diff --git a/docs/functions/toUnitScale.html b/docs/functions/toUnitScale.html index e4b2cd0..c258c9f 100644 --- a/docs/functions/toUnitScale.html +++ b/docs/functions/toUnitScale.html @@ -1,5 +1,5 @@ -toUnitScale | s2json-spec - v1.4.0

    Function toUnitScale

    • Reproject GeoJSON geometry coordinates from lon-lat to a 0->1 coordinate system in place

      +toUnitScale | s2json-spec - v1.4.1

      Function toUnitScale

      • Reproject GeoJSON geometry coordinates from lon-lat to a 0->1 coordinate system in place

        Parameters

        • feature: VectorFeature

          input GeoJSON

        • Optionaltolerance: number

          if provided, geometry will be prepared for simplification by this tolerance

        • Optionalmaxzoom: number

          if provided,

          -

        Returns void

      +

    Returns void

    diff --git a/docs/functions/toVector.html b/docs/functions/toVector.html index bf1a56d..8fa1c17 100644 --- a/docs/functions/toVector.html +++ b/docs/functions/toVector.html @@ -1,6 +1,6 @@ -toVector | s2json-spec - v1.4.0

    Function toVector

    • Convert a GeoJSON Feature to a GeoJSON Vector Feature

      +toVector | s2json-spec - v1.4.1

      Function toVector

      • Convert a GeoJSON Feature to a GeoJSON Vector Feature

        Parameters

        Returns VectorFeature

        • GeoJson Vector Feature
        -
      +
    diff --git a/docs/functions/toWM.html b/docs/functions/toWM.html index 696fc76..5084486 100644 --- a/docs/functions/toWM.html +++ b/docs/functions/toWM.html @@ -1,6 +1,6 @@ -toWM | s2json-spec - v1.4.0

    Function toWM

    • Convert an S2Feature to a GeoJSON Feature

      +toWM | s2json-spec - v1.4.1

      Function toWM

      +
    diff --git a/docs/functions/transformPoint.html b/docs/functions/transformPoint.html index 7fff7b2..b0404c4 100644 --- a/docs/functions/transformPoint.html +++ b/docs/functions/transformPoint.html @@ -1,5 +1,5 @@ -transformPoint | s2json-spec - v1.4.0

    Function transformPoint

    • Parameters

      • vp: VectorPoint

        input vector point that we are mutating in place

        +transformPoint | s2json-spec - v1.4.1

        Function transformPoint

        • Parameters

          • vp: VectorPoint

            input vector point that we are mutating in place

          • zoom: number

            current zoom

          • ti: number

            x translation

          • tj: number

            y translation

            -

          Returns void

        +

      Returns void

    diff --git a/docs/functions/xyzToLonLat.html b/docs/functions/xyzToLonLat.html index 45a9b6b..805e8e5 100644 --- a/docs/functions/xyzToLonLat.html +++ b/docs/functions/xyzToLonLat.html @@ -1,6 +1,6 @@ -xyzToLonLat | s2json-spec - v1.4.0

    Function xyzToLonLat

    • Convert from an left-hand-rule XYZ Point to a lon-lat coord

      +xyzToLonLat | s2json-spec - v1.4.1

      Function xyzToLonLat

      • Convert from an left-hand-rule XYZ Point to a lon-lat coord

        Parameters

        Returns [lon: number, lat: number]

        • lon-lat coordinates
        -
      +
    diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 6ad3107..2b41971 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -s2json-spec - v1.4.0

    s2json-spec - v1.4.0

    Class Hierarchy

    +s2json-spec - v1.4.1

    s2json-spec - v1.4.1

    Class Hierarchy

    diff --git a/docs/index.html b/docs/index.html index f38f261..d17e37a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -s2json-spec - v1.4.0

    s2json-spec - v1.4.0

    +s2json-spec - v1.4.1
    +

    diff --git a/docs/interfaces/BaseFeature.html b/docs/interfaces/BaseFeature.html index a0752b3..c549c85 100644 --- a/docs/interfaces/BaseFeature.html +++ b/docs/interfaces/BaseFeature.html @@ -1,2 +1,2 @@ -BaseFeature | s2json-spec - v1.4.0

    Interface BaseFeature<T, P, G>

    Base component to build either an S2 or WG Feature

    -

    Type Parameters

    Hierarchy (view full)

    +BaseFeature | s2json-spec - v1.4.1

    Interface BaseFeature<T, P, G>

    Base component to build either an S2 or WG Feature

    +

    Type Parameters

    Hierarchy (view full)

    diff --git a/docs/interfaces/BaseFeatureCollection.html b/docs/interfaces/BaseFeatureCollection.html index 28231c2..159a8e1 100644 --- a/docs/interfaces/BaseFeatureCollection.html +++ b/docs/interfaces/BaseFeatureCollection.html @@ -1,2 +1,2 @@ -BaseFeatureCollection | s2json-spec - v1.4.0

    Interface BaseFeatureCollection<T, F>

    Either an S2 or WG FeatureCollection

    -

    Type Parameters

    Hierarchy (view full)

    +BaseFeatureCollection | s2json-spec - v1.4.1

    Interface BaseFeatureCollection<T, F>

    Either an S2 or WG FeatureCollection

    +

    Type Parameters

    Hierarchy (view full)

    diff --git a/docs/interfaces/BaseGeometry.html b/docs/interfaces/BaseGeometry.html index 0ab307d..9855d54 100644 --- a/docs/interfaces/BaseGeometry.html +++ b/docs/interfaces/BaseGeometry.html @@ -1,2 +1,2 @@ -BaseGeometry | s2json-spec - v1.4.0

    Interface BaseGeometry<T, C, M, B>

    BaseGeometry with MValues is the a generic geometry type that includes MValues

    -

    Type Parameters

    +BaseGeometry | s2json-spec - v1.4.1

    Interface BaseGeometry<T, C, M, B>

    BaseGeometry with MValues is the a generic geometry type that includes MValues

    +

    Type Parameters

    diff --git a/docs/interfaces/S2Feature.html b/docs/interfaces/S2Feature.html index 54def6d..ec4fd86 100644 --- a/docs/interfaces/S2Feature.html +++ b/docs/interfaces/S2Feature.html @@ -1,2 +1,2 @@ -S2Feature | s2json-spec - v1.4.0

    Interface S2Feature<P, G>

    S2 Feature

    -

    Type Parameters

    Hierarchy (view full)

    +S2Feature | s2json-spec - v1.4.1

    Interface S2Feature<P, G>

    S2 Feature

    +

    Type Parameters

    Hierarchy (view full)

    diff --git a/docs/interfaces/S2FeatureCollection.html b/docs/interfaces/S2FeatureCollection.html index f34315c..9203d53 100644 --- a/docs/interfaces/S2FeatureCollection.html +++ b/docs/interfaces/S2FeatureCollection.html @@ -1,2 +1,2 @@ -S2FeatureCollection | s2json-spec - v1.4.0

    Interface S2FeatureCollection

    S2 FeatureCollection

    -

    Hierarchy (view full)

    +S2FeatureCollection | s2json-spec - v1.4.1

    Interface S2FeatureCollection

    S2 FeatureCollection

    +

    Hierarchy (view full)

    diff --git a/docs/interfaces/TileStoreOptions.html b/docs/interfaces/TileStoreOptions.html index e110239..678812a 100644 --- a/docs/interfaces/TileStoreOptions.html +++ b/docs/interfaces/TileStoreOptions.html @@ -1,4 +1,4 @@ -TileStoreOptions | s2json-spec - v1.4.0

    Interface TileStoreOptions

    Options for creating a TileStore

    +TileStoreOptions | s2json-spec - v1.4.1

    Interface TileStoreOptions

    Options for creating a TileStore

    interface TileStoreOptions {
        buffer?: number;
        indexMaxzoom?: number;
        maxzoom?: number;
        minzoom?: number;
        projection?: Projection;
        tolerance?: number;
    }

    Properties

    buffer? indexMaxzoom? maxzoom? @@ -11,4 +11,4 @@
    minzoom?: number

    min zoom to generate data on

    projection?: Projection

    manually set the projection, otherwise it defaults to whatever the data type is

    tolerance?: number

    simplification tolerance (higher means simpler)

    -
    +
    diff --git a/docs/interfaces/VectorBaseGeometry.html b/docs/interfaces/VectorBaseGeometry.html index ddaf8f7..0f38cae 100644 --- a/docs/interfaces/VectorBaseGeometry.html +++ b/docs/interfaces/VectorBaseGeometry.html @@ -1,2 +1,2 @@ -VectorBaseGeometry | s2json-spec - v1.4.0

    Interface VectorBaseGeometry<T, C, O, B>

    BaseGeometry with MValues is the a generic geometry type that includes MValues

    -

    Type Parameters

    +VectorBaseGeometry | s2json-spec - v1.4.1

    Interface VectorBaseGeometry<T, C, O, B>

    BaseGeometry with MValues is the a generic geometry type that includes MValues

    +

    Type Parameters

    diff --git a/docs/interfaces/VectorPoint.html b/docs/interfaces/VectorPoint.html index e697375..01114d3 100644 --- a/docs/interfaces/VectorPoint.html +++ b/docs/interfaces/VectorPoint.html @@ -1,2 +1,2 @@ -VectorPoint | s2json-spec - v1.4.0

    Interface VectorPoint

    Definition of a Vector Point

    -
    +VectorPoint | s2json-spec - v1.4.1

    Interface VectorPoint

    Definition of a Vector Point

    +
    diff --git a/docs/modules.html b/docs/modules.html index e60f665..2d634e7 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -s2json-spec - v1.4.0

    s2json-spec - v1.4.0

    Index

    Namespaces

    MercPoint +s2json-spec - v1.4.1

    s2json-spec - v1.4.1

    Index

    Namespaces

    +
    diff --git a/docs/modules/MercPoint.html b/docs/modules/MercPoint.html index c8e7c55..1ded931 100644 --- a/docs/modules/MercPoint.html +++ b/docs/modules/MercPoint.html @@ -1,4 +1,4 @@ -MercPoint | s2json-spec - v1.4.0

    Namespace MercPoint

    Index

    Type Aliases

    Sources +MercPoint | s2json-spec - v1.4.1

    Namespace MercPoint

    Index

    Type Aliases

    Functions

    +
    diff --git a/docs/modules/S2CellID.html b/docs/modules/S2CellID.html index 7c3105d..44fecf9 100644 --- a/docs/modules/S2CellID.html +++ b/docs/modules/S2CellID.html @@ -1,4 +1,4 @@ -S2CellID | s2json-spec - v1.4.0

    Namespace S2CellID

    Index

    Functions

    boundsST +S2CellID | s2json-spec - v1.4.1

    Namespace S2CellID

    Index

    Functions

    +
    diff --git a/docs/modules/S2Point.html b/docs/modules/S2Point.html index 3cc9398..b9e0789 100644 --- a/docs/modules/S2Point.html +++ b/docs/modules/S2Point.html @@ -1,4 +1,4 @@ -S2Point | s2json-spec - v1.4.0

    Namespace S2Point

    Index

    Functions

    add +S2Point | s2json-spec - v1.4.1

    Namespace S2Point

    Index

    Functions

    +
    diff --git a/docs/modules/mercID.html b/docs/modules/mercID.html index 5d9c22c..68ff7db 100644 --- a/docs/modules/mercID.html +++ b/docs/modules/mercID.html @@ -1,4 +1,4 @@ -mercID | s2json-spec - v1.4.0

    Namespace mercID

    Index

    Functions

    children +mercID | s2json-spec - v1.4.1

    Namespace mercID

    Index

    Functions

    +
    diff --git a/docs/types/Attributions.html b/docs/types/Attributions.html index d0182f9..3d942dc 100644 --- a/docs/types/Attributions.html +++ b/docs/types/Attributions.html @@ -1,4 +1,4 @@ -Attributions | s2json-spec - v1.4.0

    Type Alias Attributions

    Attributions: Record<string, string>

    Attribution data is stored in an object. +Attributions | s2json-spec - v1.4.1

    Type Alias Attributions

    Attributions: Record<string, string>

    Attribution data is stored in an object. The key is the name of the attribution, and the value is the href link e.g. { "Open S2": "https://opens2.com/legal/data" }

    -
    +
    diff --git a/docs/types/BBOX.html b/docs/types/BBOX.html index 94e3532..e50c169 100644 --- a/docs/types/BBOX.html +++ b/docs/types/BBOX.html @@ -1,2 +1,2 @@ -BBOX | s2json-spec - v1.4.0

    Type Alias BBOX

    BBOX: BBox | BBox3D

    Either a 2D or 3D bounding box

    -
    +BBOX | s2json-spec - v1.4.1

    Type Alias BBOX

    BBOX: BBox | BBox3D

    Either a 2D or 3D bounding box

    +
    diff --git a/docs/types/BBox-1.html b/docs/types/BBox-1.html index 73c6217..72cb37c 100644 --- a/docs/types/BBox-1.html +++ b/docs/types/BBox-1.html @@ -1,3 +1,3 @@ -BBox | s2json-spec - v1.4.0

    Type Alias BBox

    BBox: [left: number, bottom: number, right: number, top: number]

    A BBOX is defined in lon-lat space and helps with zooming motion to +BBox | s2json-spec - v1.4.1

    Type Alias BBox

    BBox: [left: number, bottom: number, right: number, top: number]

    A BBOX is defined in lon-lat space and helps with zooming motion to see the entire line or polygon

    -
    +
    diff --git a/docs/types/BBox3D.html b/docs/types/BBox3D.html index 155589a..fa8e655 100644 --- a/docs/types/BBox3D.html +++ b/docs/types/BBox3D.html @@ -1,3 +1,3 @@ -BBox3D | s2json-spec - v1.4.0

    Type Alias BBox3D

    BBox3D: [left: number, bottom: number, right: number, top: number, front: number, back: number]

    A BBOX is defined in lon-lat space and helps with zooming motion to +BBox3D | s2json-spec - v1.4.1

    Type Alias BBox3D

    BBox3D: [left: number, bottom: number, right: number, top: number, front: number, back: number]

    A BBOX is defined in lon-lat space and helps with zooming motion to see the entire 3D line or polygon

    -
    +
    diff --git a/docs/types/ConvertedGeometry.html b/docs/types/ConvertedGeometry.html index c1884ff..432c445 100644 --- a/docs/types/ConvertedGeometry.html +++ b/docs/types/ConvertedGeometry.html @@ -1,2 +1,2 @@ -ConvertedGeometry | s2json-spec - v1.4.0

    Type Alias ConvertedGeometry

    ConvertedGeometry: {
        face: Face;
        geometry: VectorGeometry;
    }[]

    The resultant geometry after conversion

    -
    +ConvertedGeometry | s2json-spec - v1.4.1

    Type Alias ConvertedGeometry

    ConvertedGeometry: {
        face: Face;
        geometry: VectorGeometry;
    }[]

    The resultant geometry after conversion

    +
    diff --git a/docs/types/Coordinates.html b/docs/types/Coordinates.html index 18ff0af..4293ec8 100644 --- a/docs/types/Coordinates.html +++ b/docs/types/Coordinates.html @@ -1,2 +1,2 @@ -Coordinates | s2json-spec - v1.4.0

    Type Alias Coordinates

    Coordinates:
        | Point
        | MultiPoint
        | LineString
        | MultiLineString
        | Polygon
        | MultiPolygon
        | Point3D
        | MultiPoint3D
        | LineString3D
        | MultiLineString3D
        | Polygon3D
        | MultiPolygon3D

    All possible geometry coordinates

    -
    +Coordinates | s2json-spec - v1.4.1

    Type Alias Coordinates

    Coordinates:
        | Point
        | MultiPoint
        | LineString
        | MultiLineString
        | Polygon
        | MultiPolygon
        | Point3D
        | MultiPoint3D
        | LineString3D
        | MultiLineString3D
        | Polygon3D
        | MultiPolygon3D

    All possible geometry coordinates

    +
    diff --git a/docs/types/Face.html b/docs/types/Face.html index df5ce73..704b531 100644 --- a/docs/types/Face.html +++ b/docs/types/Face.html @@ -1,2 +1,2 @@ -Face | s2json-spec - v1.4.0

    Type Alias Face

    Face:
        | 0
        | 1
        | 2
        | 3
        | 4
        | 5

    cube-face on the S2 sphere

    -
    +Face | s2json-spec - v1.4.1

    Type Alias Face

    Face:
        | 0
        | 1
        | 2
        | 3
        | 4
        | 5

    cube-face on the S2 sphere

    +
    diff --git a/docs/types/Feature.html b/docs/types/Feature.html index 4ac8924..4f76338 100644 --- a/docs/types/Feature.html +++ b/docs/types/Feature.html @@ -1,2 +1,2 @@ -Feature | s2json-spec - v1.4.0

    Type Alias Feature<P, M, G>

    Feature<P, M, G>: BaseFeature<"Feature", P, G>

    WG Feature

    -

    Type Parameters

    +Feature | s2json-spec - v1.4.1

    Type Alias Feature<P, M, G>

    Feature<P, M, G>: BaseFeature<"Feature", P, G>

    WG Feature

    +

    Type Parameters

    diff --git a/docs/types/FeatureCollection.html b/docs/types/FeatureCollection.html index b5f4d25..dc5bb49 100644 --- a/docs/types/FeatureCollection.html +++ b/docs/types/FeatureCollection.html @@ -1,2 +1,2 @@ -FeatureCollection | s2json-spec - v1.4.0

    Type Alias FeatureCollection

    FeatureCollection: BaseFeatureCollection<"FeatureCollection", Feature | VectorFeature>

    WG FeatureCollection

    -
    +FeatureCollection | s2json-spec - v1.4.1

    Type Alias FeatureCollection

    FeatureCollection: BaseFeatureCollection<"FeatureCollection", Feature | VectorFeature>

    WG FeatureCollection

    +
    diff --git a/docs/types/FeatureCollectionType.html b/docs/types/FeatureCollectionType.html index c2b0fcd..b1273f5 100644 --- a/docs/types/FeatureCollectionType.html +++ b/docs/types/FeatureCollectionType.html @@ -1,2 +1,2 @@ -FeatureCollectionType | s2json-spec - v1.4.0

    Type Alias FeatureCollectionType

    FeatureCollectionType: "FeatureCollection" | "S2FeatureCollection"

    Types will either be an S2 or WG FeatureCollection

    -
    +FeatureCollectionType | s2json-spec - v1.4.1

    Type Alias FeatureCollectionType

    FeatureCollectionType: "FeatureCollection" | "S2FeatureCollection"

    Types will either be an S2 or WG FeatureCollection

    +
    diff --git a/docs/types/FeatureCollections.html b/docs/types/FeatureCollections.html index bdc94b1..1249dac 100644 --- a/docs/types/FeatureCollections.html +++ b/docs/types/FeatureCollections.html @@ -1,2 +1,2 @@ -FeatureCollections | s2json-spec - v1.4.0

    Type Alias FeatureCollections

    Either an S2 or WG FeatureCollection

    -
    +FeatureCollections | s2json-spec - v1.4.1

    Type Alias FeatureCollections

    Either an S2 or WG FeatureCollection

    +
    diff --git a/docs/types/FeatureType.html b/docs/types/FeatureType.html index be5aee6..d9b030d 100644 --- a/docs/types/FeatureType.html +++ b/docs/types/FeatureType.html @@ -1,2 +1,2 @@ -FeatureType | s2json-spec - v1.4.0

    Type Alias FeatureType

    FeatureType: "Feature" | "VectorFeature" | "S2Feature"

    Either an S2 or WG Feature type

    -
    +FeatureType | s2json-spec - v1.4.1

    Type Alias FeatureType

    FeatureType: "Feature" | "VectorFeature" | "S2Feature"

    Either an S2 or WG Feature type

    +
    diff --git a/docs/types/Features.html b/docs/types/Features.html index cdc5e5a..5e86dbd 100644 --- a/docs/types/Features.html +++ b/docs/types/Features.html @@ -1,2 +1,2 @@ -Features | s2json-spec - v1.4.0

    Type Alias Features

    Either an S2 or WG Feature

    -
    +Features | s2json-spec - v1.4.1

    Type Alias Features

    Either an S2 or WG Feature

    +
    diff --git a/docs/types/Geometry.html b/docs/types/Geometry.html index f062383..5c77653 100644 --- a/docs/types/Geometry.html +++ b/docs/types/Geometry.html @@ -1,2 +1,2 @@ -Geometry | s2json-spec - v1.4.0

    Type Alias Geometry<M>

    Geometry<M>:
        | PointGeometry<M>
        | MultiPointGeometry<M>
        | LineStringGeometry<M>
        | MultiLineStringGeometry<M>
        | PolygonGeometry<M>
        | MultiPolygonGeometry<M>
        | Point3DGeometry<M>
        | MultiPoint3DGeometry<M>
        | LineString3DGeometry<M>
        | MultiLineString3DGeometry<M>
        | Polygon3DGeometry<M>
        | MultiPolygon3DGeometry<M>

    All possible geometry shapes

    -

    Type Parameters

    +Geometry | s2json-spec - v1.4.1

    Type Alias Geometry<M>

    Geometry<M>:
        | PointGeometry<M>
        | MultiPointGeometry<M>
        | LineStringGeometry<M>
        | MultiLineStringGeometry<M>
        | PolygonGeometry<M>
        | MultiPolygonGeometry<M>
        | Point3DGeometry<M>
        | MultiPoint3DGeometry<M>
        | LineString3DGeometry<M>
        | MultiLineString3DGeometry<M>
        | Polygon3DGeometry<M>
        | MultiPolygon3DGeometry<M>

    All possible geometry shapes

    +

    Type Parameters

    diff --git a/docs/types/GeometryType.html b/docs/types/GeometryType.html index bc9d90a..72d3802 100644 --- a/docs/types/GeometryType.html +++ b/docs/types/GeometryType.html @@ -1,2 +1,2 @@ -GeometryType | s2json-spec - v1.4.0

    Type Alias GeometryType

    GeometryType:
        | "Point"
        | "MultiPoint"
        | "LineString"
        | "MultiLineString"
        | "Polygon"
        | "MultiPolygon"
        | "Point3D"
        | "MultiPoint3D"
        | "LineString3D"
        | "MultiLineString3D"
        | "Polygon3D"
        | "MultiPolygon3D"

    All possible geometry types

    -
    +GeometryType | s2json-spec - v1.4.1

    Type Alias GeometryType

    GeometryType:
        | "Point"
        | "MultiPoint"
        | "LineString"
        | "MultiLineString"
        | "Polygon"
        | "MultiPolygon"
        | "Point3D"
        | "MultiPoint3D"
        | "LineString3D"
        | "MultiLineString3D"
        | "Polygon3D"
        | "MultiPolygon3D"

    All possible geometry types

    +
    diff --git a/docs/types/JSONCollection.html b/docs/types/JSONCollection.html index 56e6593..6fcb2e3 100644 --- a/docs/types/JSONCollection.html +++ b/docs/types/JSONCollection.html @@ -1,2 +1,2 @@ -JSONCollection | s2json-spec - v1.4.0

    Type Alias JSONCollection

    All major S2JSON types

    -
    +JSONCollection | s2json-spec - v1.4.1

    Type Alias JSONCollection

    All major S2JSON types

    +
    diff --git a/docs/types/LineString.html b/docs/types/LineString.html index 52aba55..b3ae856 100644 --- a/docs/types/LineString.html +++ b/docs/types/LineString.html @@ -1,2 +1,2 @@ -LineString | s2json-spec - v1.4.0

    Type Alias LineString

    LineString: Point[]

    Definition of a LineString

    -
    +LineString | s2json-spec - v1.4.1

    Type Alias LineString

    LineString: Point[]

    Definition of a LineString

    +
    diff --git a/docs/types/LineString3D.html b/docs/types/LineString3D.html index 3744432..ca64f60 100644 --- a/docs/types/LineString3D.html +++ b/docs/types/LineString3D.html @@ -1,2 +1,2 @@ -LineString3D | s2json-spec - v1.4.0

    Type Alias LineString3D

    LineString3D: Point3D[]

    Definition of a 3D LineString

    -
    +LineString3D | s2json-spec - v1.4.1

    Type Alias LineString3D

    LineString3D: Point3D[]

    Definition of a 3D LineString

    +
    diff --git a/docs/types/LineString3DGeometry.html b/docs/types/LineString3DGeometry.html index 6e1f669..9c70449 100644 --- a/docs/types/LineString3DGeometry.html +++ b/docs/types/LineString3DGeometry.html @@ -1,2 +1,2 @@ -LineString3DGeometry | s2json-spec - v1.4.0

    Type Alias LineString3DGeometry<M>

    LineString3DGeometry<M>: BaseGeometry<"LineString3D", LineString3D, M[], BBox3D>

    LineString3DGeometry is a 3D line

    -

    Type Parameters

    +LineString3DGeometry | s2json-spec - v1.4.1

    Type Alias LineString3DGeometry<M>

    LineString3DGeometry<M>: BaseGeometry<"LineString3D", LineString3D, M[], BBox3D>

    LineString3DGeometry is a 3D line

    +

    Type Parameters

    diff --git a/docs/types/LineStringGeometry.html b/docs/types/LineStringGeometry.html index af41ea0..e25ecb0 100644 --- a/docs/types/LineStringGeometry.html +++ b/docs/types/LineStringGeometry.html @@ -1,2 +1,2 @@ -LineStringGeometry | s2json-spec - v1.4.0

    Type Alias LineStringGeometry<M>

    LineStringGeometry<M>: BaseGeometry<"LineString", LineString, M[], BBox>

    LineStringGeometry is a line

    -

    Type Parameters

    +LineStringGeometry | s2json-spec - v1.4.1

    Type Alias LineStringGeometry<M>

    LineStringGeometry<M>: BaseGeometry<"LineString", LineString, M[], BBox>

    LineStringGeometry is a line

    +

    Type Parameters

    diff --git a/docs/types/LineStringMValues.html b/docs/types/LineStringMValues.html index 101c420..53de53c 100644 --- a/docs/types/LineStringMValues.html +++ b/docs/types/LineStringMValues.html @@ -1,2 +1,2 @@ -LineStringMValues | s2json-spec - v1.4.0

    Type Alias LineStringMValues<M>

    LineStringMValues<M>: M[]

    LineString Properties Shape

    -

    Type Parameters

    +LineStringMValues | s2json-spec - v1.4.1

    Type Alias LineStringMValues<M>

    LineStringMValues<M>: M[]

    LineString Properties Shape

    +

    Type Parameters

    diff --git a/docs/types/MValue.html b/docs/types/MValue.html index ffd88bd..5594629 100644 --- a/docs/types/MValue.html +++ b/docs/types/MValue.html @@ -1,2 +1,2 @@ -MValue | s2json-spec - v1.4.0

    Type Alias MValue

    MValue: Properties

    Shape of a feature's M-Values object

    -
    +MValue | s2json-spec - v1.4.1

    Type Alias MValue

    MValue: Properties

    Shape of a feature's M-Values object

    +
    diff --git a/docs/types/MValues.html b/docs/types/MValues.html index 351f995..9283ce9 100644 --- a/docs/types/MValues.html +++ b/docs/types/MValues.html @@ -1,2 +1,2 @@ -MValues | s2json-spec - v1.4.0

    Type Alias MValues

    MValues:
        | any[]
        | MultiLineStringMValues
        | PolygonMValues
        | MultiPolygonMValues

    All possible M-Value shapes

    -
    +MValues | s2json-spec - v1.4.1

    Type Alias MValues

    MValues:
        | any[]
        | MultiLineStringMValues
        | PolygonMValues
        | MultiPolygonMValues

    All possible M-Value shapes

    +
    diff --git a/docs/types/MercPoint.Sources.html b/docs/types/MercPoint.Sources.html index 3968bdd..3f0e75e 100644 --- a/docs/types/MercPoint.Sources.html +++ b/docs/types/MercPoint.Sources.html @@ -1,2 +1,2 @@ -Sources | s2json-spec - v1.4.0

    Type Alias Sources

    Sources: "WGS84" | "900913"

    The source of the coordinate inputs

    -
    +Sources | s2json-spec - v1.4.1

    Type Alias Sources

    Sources: "WGS84" | "900913"

    The source of the coordinate inputs

    +
    diff --git a/docs/types/MultiLineString.html b/docs/types/MultiLineString.html index b518eb0..cbce39a 100644 --- a/docs/types/MultiLineString.html +++ b/docs/types/MultiLineString.html @@ -1,2 +1,2 @@ -MultiLineString | s2json-spec - v1.4.0

    Type Alias MultiLineString

    MultiLineString: LineString[]

    Definition of a MultiLineString

    -
    +MultiLineString | s2json-spec - v1.4.1

    Type Alias MultiLineString

    MultiLineString: LineString[]

    Definition of a MultiLineString

    +
    diff --git a/docs/types/MultiLineString3D.html b/docs/types/MultiLineString3D.html index 96b9780..32ea993 100644 --- a/docs/types/MultiLineString3D.html +++ b/docs/types/MultiLineString3D.html @@ -1,2 +1,2 @@ -MultiLineString3D | s2json-spec - v1.4.0

    Type Alias MultiLineString3D

    MultiLineString3D: LineString3D[]

    Definition of a 3D MultiLineString

    -
    +MultiLineString3D | s2json-spec - v1.4.1

    Type Alias MultiLineString3D

    MultiLineString3D: LineString3D[]

    Definition of a 3D MultiLineString

    +
    diff --git a/docs/types/MultiLineString3DGeometry.html b/docs/types/MultiLineString3DGeometry.html index 91a3acf..50dff8a 100644 --- a/docs/types/MultiLineString3DGeometry.html +++ b/docs/types/MultiLineString3DGeometry.html @@ -1,2 +1,2 @@ -MultiLineString3DGeometry | s2json-spec - v1.4.0

    Type Alias MultiLineString3DGeometry<M>

    MultiLineString3DGeometry<M>: BaseGeometry<"MultiLineString3D", MultiLineString3D, MultiLineStringMValues<M>, BBox3D>

    MultiLineString3DGeometry contians multiple 3D lines

    -

    Type Parameters

    +MultiLineString3DGeometry | s2json-spec - v1.4.1

    Type Alias MultiLineString3DGeometry<M>

    MultiLineString3DGeometry<M>: BaseGeometry<"MultiLineString3D", MultiLineString3D, MultiLineStringMValues<M>, BBox3D>

    MultiLineString3DGeometry contians multiple 3D lines

    +

    Type Parameters

    diff --git a/docs/types/MultiLineStringGeometry.html b/docs/types/MultiLineStringGeometry.html index db9c8f8..e71d443 100644 --- a/docs/types/MultiLineStringGeometry.html +++ b/docs/types/MultiLineStringGeometry.html @@ -1,2 +1,2 @@ -MultiLineStringGeometry | s2json-spec - v1.4.0

    Type Alias MultiLineStringGeometry<M>

    MultiLineStringGeometry<M>: BaseGeometry<"MultiLineString", MultiLineString, MultiLineStringMValues<M>, BBox>

    MultiLineStringGeometry contians multiple lines

    -

    Type Parameters

    +MultiLineStringGeometry | s2json-spec - v1.4.1

    Type Alias MultiLineStringGeometry<M>

    MultiLineStringGeometry<M>: BaseGeometry<"MultiLineString", MultiLineString, MultiLineStringMValues<M>, BBox>

    MultiLineStringGeometry contians multiple lines

    +

    Type Parameters

    diff --git a/docs/types/MultiLineStringMValues.html b/docs/types/MultiLineStringMValues.html index bcd41af..500406d 100644 --- a/docs/types/MultiLineStringMValues.html +++ b/docs/types/MultiLineStringMValues.html @@ -1,2 +1,2 @@ -MultiLineStringMValues | s2json-spec - v1.4.0

    Type Alias MultiLineStringMValues<M>

    MultiLineStringMValues<M>: M[][]

    MultiLineString Properties Shape

    -

    Type Parameters

    +MultiLineStringMValues | s2json-spec - v1.4.1

    Type Alias MultiLineStringMValues<M>

    MultiLineStringMValues<M>: M[][]

    MultiLineString Properties Shape

    +

    Type Parameters

    diff --git a/docs/types/MultiPoint.html b/docs/types/MultiPoint.html index d84044b..af11924 100644 --- a/docs/types/MultiPoint.html +++ b/docs/types/MultiPoint.html @@ -1,2 +1,2 @@ -MultiPoint | s2json-spec - v1.4.0

    Type Alias MultiPoint

    MultiPoint: Point[]

    Definition of a MultiPoint

    -
    +MultiPoint | s2json-spec - v1.4.1

    Type Alias MultiPoint

    MultiPoint: Point[]

    Definition of a MultiPoint

    +
    diff --git a/docs/types/MultiPoint3D.html b/docs/types/MultiPoint3D.html index 0ba468d..ad43d8c 100644 --- a/docs/types/MultiPoint3D.html +++ b/docs/types/MultiPoint3D.html @@ -1,2 +1,2 @@ -MultiPoint3D | s2json-spec - v1.4.0

    Type Alias MultiPoint3D

    MultiPoint3D: Point3D[]

    Definition of a 3D MultiPoint

    -
    +MultiPoint3D | s2json-spec - v1.4.1

    Type Alias MultiPoint3D

    MultiPoint3D: Point3D[]

    Definition of a 3D MultiPoint

    +
    diff --git a/docs/types/MultiPoint3DGeometry.html b/docs/types/MultiPoint3DGeometry.html index e2a38b3..7a84597 100644 --- a/docs/types/MultiPoint3DGeometry.html +++ b/docs/types/MultiPoint3DGeometry.html @@ -1,2 +1,2 @@ -MultiPoint3DGeometry | s2json-spec - v1.4.0

    Type Alias MultiPoint3DGeometry<M>

    MultiPoint3DGeometry<M>: BaseGeometry<"MultiPoint3D", MultiPoint3D, M[], BBox3D>

    MultiPoint3DGeometry contains multiple 3D points

    -

    Type Parameters

    +MultiPoint3DGeometry | s2json-spec - v1.4.1

    Type Alias MultiPoint3DGeometry<M>

    MultiPoint3DGeometry<M>: BaseGeometry<"MultiPoint3D", MultiPoint3D, M[], BBox3D>

    MultiPoint3DGeometry contains multiple 3D points

    +

    Type Parameters

    diff --git a/docs/types/MultiPointGeometry.html b/docs/types/MultiPointGeometry.html index 66bf63c..9f69ea9 100644 --- a/docs/types/MultiPointGeometry.html +++ b/docs/types/MultiPointGeometry.html @@ -1,2 +1,2 @@ -MultiPointGeometry | s2json-spec - v1.4.0

    Type Alias MultiPointGeometry<M>

    MultiPointGeometry<M>: BaseGeometry<"MultiPoint", MultiPoint, M[], BBox>

    MultiPointGeometry contains multiple points

    -

    Type Parameters

    +MultiPointGeometry | s2json-spec - v1.4.1

    Type Alias MultiPointGeometry<M>

    MultiPointGeometry<M>: BaseGeometry<"MultiPoint", MultiPoint, M[], BBox>

    MultiPointGeometry contains multiple points

    +

    Type Parameters

    diff --git a/docs/types/MultiPolygon.html b/docs/types/MultiPolygon.html index a4091d0..ac4700f 100644 --- a/docs/types/MultiPolygon.html +++ b/docs/types/MultiPolygon.html @@ -1,2 +1,2 @@ -MultiPolygon | s2json-spec - v1.4.0

    Type Alias MultiPolygon

    MultiPolygon: Polygon[]

    Definition of a MultiPolygon

    -
    +MultiPolygon | s2json-spec - v1.4.1

    Type Alias MultiPolygon

    MultiPolygon: Polygon[]

    Definition of a MultiPolygon

    +
    diff --git a/docs/types/MultiPolygon3D.html b/docs/types/MultiPolygon3D.html index b3d3cd4..48a9652 100644 --- a/docs/types/MultiPolygon3D.html +++ b/docs/types/MultiPolygon3D.html @@ -1,2 +1,2 @@ -MultiPolygon3D | s2json-spec - v1.4.0

    Type Alias MultiPolygon3D

    MultiPolygon3D: Polygon3D[]

    Definition of a 3D MultiPolygon

    -
    +MultiPolygon3D | s2json-spec - v1.4.1

    Type Alias MultiPolygon3D

    MultiPolygon3D: Polygon3D[]

    Definition of a 3D MultiPolygon

    +
    diff --git a/docs/types/MultiPolygon3DGeometry.html b/docs/types/MultiPolygon3DGeometry.html index 6355ed9..c68589b 100644 --- a/docs/types/MultiPolygon3DGeometry.html +++ b/docs/types/MultiPolygon3DGeometry.html @@ -1,2 +1,2 @@ -MultiPolygon3DGeometry | s2json-spec - v1.4.0

    Type Alias MultiPolygon3DGeometry<M>

    MultiPolygon3DGeometry<M>: BaseGeometry<"MultiPolygon3D", MultiPolygon3D, MultiPolygonMValues<M>, BBox3D>

    MultiPolygon3DGeometry is a 3D polygon with multiple polygons with their own potential holes

    -

    Type Parameters

    +MultiPolygon3DGeometry | s2json-spec - v1.4.1

    Type Alias MultiPolygon3DGeometry<M>

    MultiPolygon3DGeometry<M>: BaseGeometry<"MultiPolygon3D", MultiPolygon3D, MultiPolygonMValues<M>, BBox3D>

    MultiPolygon3DGeometry is a 3D polygon with multiple polygons with their own potential holes

    +

    Type Parameters

    diff --git a/docs/types/MultiPolygonGeometry.html b/docs/types/MultiPolygonGeometry.html index a568fb0..e66c6ec 100644 --- a/docs/types/MultiPolygonGeometry.html +++ b/docs/types/MultiPolygonGeometry.html @@ -1,2 +1,2 @@ -MultiPolygonGeometry | s2json-spec - v1.4.0

    Type Alias MultiPolygonGeometry<M>

    MultiPolygonGeometry<M>: BaseGeometry<"MultiPolygon", MultiPolygon, MultiPolygonMValues<M>, BBox>

    MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes

    -

    Type Parameters

    +MultiPolygonGeometry | s2json-spec - v1.4.1

    Type Alias MultiPolygonGeometry<M>

    MultiPolygonGeometry<M>: BaseGeometry<"MultiPolygon", MultiPolygon, MultiPolygonMValues<M>, BBox>

    MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes

    +

    Type Parameters

    diff --git a/docs/types/MultiPolygonMValues.html b/docs/types/MultiPolygonMValues.html index d271f1e..457e23e 100644 --- a/docs/types/MultiPolygonMValues.html +++ b/docs/types/MultiPolygonMValues.html @@ -1,2 +1,2 @@ -MultiPolygonMValues | s2json-spec - v1.4.0

    Type Alias MultiPolygonMValues<M>

    MultiPolygonMValues<M>: M[][][]

    MultiPolygon MValues Shape

    -

    Type Parameters

    +MultiPolygonMValues | s2json-spec - v1.4.1

    Type Alias MultiPolygonMValues<M>

    MultiPolygonMValues<M>: M[][][]

    MultiPolygon MValues Shape

    +

    Type Parameters

    diff --git a/docs/types/Point.html b/docs/types/Point.html index 084c83c..02894fa 100644 --- a/docs/types/Point.html +++ b/docs/types/Point.html @@ -1,2 +1,2 @@ -Point | s2json-spec - v1.4.0

    Type Alias Point

    Point: [x: number, y: number]

    Definition of a Point. May represent WebMercator Lon-Lat or S2Geometry S-T

    -
    +Point | s2json-spec - v1.4.1

    Type Alias Point

    Point: [x: number, y: number]

    Definition of a Point. May represent WebMercator Lon-Lat or S2Geometry S-T

    +
    diff --git a/docs/types/Point3D.html b/docs/types/Point3D.html index 5f146d1..2327d82 100644 --- a/docs/types/Point3D.html +++ b/docs/types/Point3D.html @@ -1,2 +1,2 @@ -Point3D | s2json-spec - v1.4.0

    Type Alias Point3D

    Point3D: [x: number, y: number, z: number]

    Definition of a 3D Point. May represent WebMercator Lon-Lat or S2Geometry S-T with a z-value

    -
    +Point3D | s2json-spec - v1.4.1

    Type Alias Point3D

    Point3D: [x: number, y: number, z: number]

    Definition of a 3D Point. May represent WebMercator Lon-Lat or S2Geometry S-T with a z-value

    +
    diff --git a/docs/types/Point3DGeometry.html b/docs/types/Point3DGeometry.html index 69df9dd..af021fc 100644 --- a/docs/types/Point3DGeometry.html +++ b/docs/types/Point3DGeometry.html @@ -1,2 +1,2 @@ -Point3DGeometry | s2json-spec - v1.4.0

    Type Alias Point3DGeometry<M>

    Point3DGeometry<M>: BaseGeometry<"Point3D", Point3D, M, BBox3D>

    Point3DGeometry is a 3D point

    -

    Type Parameters

    +Point3DGeometry | s2json-spec - v1.4.1

    Type Alias Point3DGeometry<M>

    Point3DGeometry<M>: BaseGeometry<"Point3D", Point3D, M, BBox3D>

    Point3DGeometry is a 3D point

    +

    Type Parameters

    diff --git a/docs/types/PointGeometry.html b/docs/types/PointGeometry.html index ea0988c..c7326e1 100644 --- a/docs/types/PointGeometry.html +++ b/docs/types/PointGeometry.html @@ -1,2 +1,2 @@ -PointGeometry | s2json-spec - v1.4.0

    Type Alias PointGeometry<M>

    PointGeometry<M>: BaseGeometry<"Point", Point, M, BBox>

    PointGeometry is a point

    -

    Type Parameters

    +PointGeometry | s2json-spec - v1.4.1

    Type Alias PointGeometry<M>

    PointGeometry<M>: BaseGeometry<"Point", Point, M, BBox>

    PointGeometry is a point

    +

    Type Parameters

    diff --git a/docs/types/Polygon.html b/docs/types/Polygon.html index 9dd9215..1f4ad20 100644 --- a/docs/types/Polygon.html +++ b/docs/types/Polygon.html @@ -1,2 +1,2 @@ -Polygon | s2json-spec - v1.4.0

    Type Alias Polygon

    Polygon: Point[][]

    Definition of a Polygon

    -
    +Polygon | s2json-spec - v1.4.1

    Type Alias Polygon

    Polygon: Point[][]

    Definition of a Polygon

    +
    diff --git a/docs/types/Polygon3D.html b/docs/types/Polygon3D.html index d6ed66b..56d1d63 100644 --- a/docs/types/Polygon3D.html +++ b/docs/types/Polygon3D.html @@ -1,2 +1,2 @@ -Polygon3D | s2json-spec - v1.4.0

    Type Alias Polygon3D

    Polygon3D: Point3D[][]

    Definition of a 3D Polygon

    -
    +Polygon3D | s2json-spec - v1.4.1

    Type Alias Polygon3D

    Polygon3D: Point3D[][]

    Definition of a 3D Polygon

    +
    diff --git a/docs/types/Polygon3DGeometry.html b/docs/types/Polygon3DGeometry.html index afc18ad..5b5c37c 100644 --- a/docs/types/Polygon3DGeometry.html +++ b/docs/types/Polygon3DGeometry.html @@ -1,2 +1,2 @@ -Polygon3DGeometry | s2json-spec - v1.4.0

    Type Alias Polygon3DGeometry<M>

    Polygon3DGeometry<M>: BaseGeometry<"Polygon3D", Polygon3D, PolygonMValues<M>, BBox3D>

    Polygon3DGeometry is a 3D polygon with potential holes

    -

    Type Parameters

    +Polygon3DGeometry | s2json-spec - v1.4.1

    Type Alias Polygon3DGeometry<M>

    Polygon3DGeometry<M>: BaseGeometry<"Polygon3D", Polygon3D, PolygonMValues<M>, BBox3D>

    Polygon3DGeometry is a 3D polygon with potential holes

    +

    Type Parameters

    diff --git a/docs/types/PolygonGeometry.html b/docs/types/PolygonGeometry.html index 8c06b17..1f62978 100644 --- a/docs/types/PolygonGeometry.html +++ b/docs/types/PolygonGeometry.html @@ -1,2 +1,2 @@ -PolygonGeometry | s2json-spec - v1.4.0

    Type Alias PolygonGeometry<M>

    PolygonGeometry<M>: BaseGeometry<"Polygon", Polygon, PolygonMValues<M>, BBox>

    PolygonGeometry is a polygon with potential holes

    -

    Type Parameters

    +PolygonGeometry | s2json-spec - v1.4.1

    Type Alias PolygonGeometry<M>

    PolygonGeometry<M>: BaseGeometry<"Polygon", Polygon, PolygonMValues<M>, BBox>

    PolygonGeometry is a polygon with potential holes

    +

    Type Parameters

    diff --git a/docs/types/PolygonMValues.html b/docs/types/PolygonMValues.html index 65a4a68..c5c4617 100644 --- a/docs/types/PolygonMValues.html +++ b/docs/types/PolygonMValues.html @@ -1,2 +1,2 @@ -PolygonMValues | s2json-spec - v1.4.0

    Type Alias PolygonMValues<M>

    PolygonMValues<M>: M[][]

    Polygon MValues Shape

    -

    Type Parameters

    +PolygonMValues | s2json-spec - v1.4.1

    Type Alias PolygonMValues<M>

    PolygonMValues<M>: M[][]

    Polygon MValues Shape

    +

    Type Parameters

    diff --git a/docs/types/Primitive.html b/docs/types/Primitive.html index c6d5823..b412c29 100644 --- a/docs/types/Primitive.html +++ b/docs/types/Primitive.html @@ -1,2 +1,2 @@ -Primitive | s2json-spec - v1.4.0

    Type Alias Primitive

    Primitive:
        | string
        | number
        | boolean
        | null

    Primitive types supported by Properties

    -
    +Primitive | s2json-spec - v1.4.1

    Type Alias Primitive

    Primitive:
        | string
        | number
        | boolean
        | null

    Primitive types supported by Properties

    +
    diff --git a/docs/types/Projection.html b/docs/types/Projection.html index 0cd878f..17f17eb 100644 --- a/docs/types/Projection.html +++ b/docs/types/Projection.html @@ -1,2 +1,2 @@ -Projection | s2json-spec - v1.4.0

    Type Alias Projection

    Projection: "WM" | "S2"

    Whether the projection is S2 or WM

    -
    +Projection | s2json-spec - v1.4.1

    Type Alias Projection

    Projection: "WM" | "S2"

    Whether the projection is S2 or WM

    +
    diff --git a/docs/types/Properties.html b/docs/types/Properties.html index d67d959..6cd6c87 100644 --- a/docs/types/Properties.html +++ b/docs/types/Properties.html @@ -1,2 +1,2 @@ -Properties | s2json-spec - v1.4.0

    Type Alias Properties

    Properties: Record<string, Value>

    Shape of a features properties object

    -
    +Properties | s2json-spec - v1.4.1

    Type Alias Properties

    Properties: Record<string, Value>

    Shape of a features properties object

    +
    diff --git a/docs/types/STPoint.html b/docs/types/STPoint.html index f1a3a4d..1acff22 100644 --- a/docs/types/STPoint.html +++ b/docs/types/STPoint.html @@ -1,2 +1,2 @@ -STPoint | s2json-spec - v1.4.0

    Type Alias STPoint

    STPoint: {
        face: Face;
        m?: MValue;
        s: number;
        t: number;
        z?: number;
    }

    A Point in S2 Space with a Face

    -
    +STPoint | s2json-spec - v1.4.1

    Type Alias STPoint

    STPoint: {
        face: Face;
        m?: MValue;
        s: number;
        t: number;
        z?: number;
    }

    A Point in S2 Space with a Face

    +
    diff --git a/docs/types/Value.html b/docs/types/Value.html index f7439db..32c936a 100644 --- a/docs/types/Value.html +++ b/docs/types/Value.html @@ -1,5 +1,5 @@ -Value | s2json-spec - v1.4.0

    Type Alias Value

    Value: Primitive | any[] | {
        [key: string]: Value;
    }

    Supports primitive types string, number, boolean, null +Value | s2json-spec - v1.4.1

    Type Alias Value

    Value: Primitive | any[] | {
        [key: string]: Value;
    }

    Supports primitive types string, number, boolean, null May be an array of those types, or an object of those types Object keys are always strings, values can be any basic type, an array, or a nested object. Array values must all be the same type.

    -
    +
    diff --git a/docs/types/ValueArray.html b/docs/types/ValueArray.html index f07d0bd..2f76c32 100644 --- a/docs/types/ValueArray.html +++ b/docs/types/ValueArray.html @@ -1,3 +1,3 @@ -ValueArray | s2json-spec - v1.4.0

    Type Alias ValueArray

    ValueArray: (Primitive | {
            [key: string]: Primitive;
        })[] extends (infer U)[]
        ? U[]
        : never

    When an array is used, it must be an array of the same type. +ValueArray | s2json-spec - v1.4.1

    Type Alias ValueArray

    ValueArray: (Primitive | {
            [key: string]: Primitive;
        })[] extends (infer U)[]
        ? U[]
        : never

    When an array is used, it must be an array of the same type. Arrays are also limited to primitives and objects of primitives

    -
    +
    diff --git a/docs/types/VectorCoordinates.html b/docs/types/VectorCoordinates.html index 211fc4e..cd5d500 100644 --- a/docs/types/VectorCoordinates.html +++ b/docs/types/VectorCoordinates.html @@ -1,2 +1,2 @@ -VectorCoordinates | s2json-spec - v1.4.0

    Type Alias VectorCoordinates

    VectorCoordinates:
        | VectorPoint
        | VectorMultiPoint
        | VectorLineString
        | VectorMultiLineString
        | VectorPolygon
        | VectorMultiPolygon

    All possible geometry coordinates

    -
    +VectorCoordinates | s2json-spec - v1.4.1

    Type Alias VectorCoordinates

    VectorCoordinates:
        | VectorPoint
        | VectorMultiPoint
        | VectorLineString
        | VectorMultiLineString
        | VectorPolygon
        | VectorMultiPolygon

    All possible geometry coordinates

    +
    diff --git a/docs/types/VectorFeature.html b/docs/types/VectorFeature.html index a42628f..6d1366d 100644 --- a/docs/types/VectorFeature.html +++ b/docs/types/VectorFeature.html @@ -1,2 +1,2 @@ -VectorFeature | s2json-spec - v1.4.0

    Type Alias VectorFeature<P, G>

    VectorFeature<P, G>: BaseFeature<"VectorFeature", P, G>

    WG Vector Feature

    -

    Type Parameters

    +VectorFeature | s2json-spec - v1.4.1

    Type Alias VectorFeature<P, G>

    VectorFeature<P, G>: BaseFeature<"VectorFeature", P, G>

    WG Vector Feature

    +

    Type Parameters

    diff --git a/docs/types/VectorFeatures.html b/docs/types/VectorFeatures.html index d967994..3d7c1e7 100644 --- a/docs/types/VectorFeatures.html +++ b/docs/types/VectorFeatures.html @@ -1,2 +1,2 @@ -VectorFeatures | s2json-spec - v1.4.0

    Type Alias VectorFeatures

    VectorFeatures: VectorFeature | S2Feature

    Any Vector Geometry type

    -
    +VectorFeatures | s2json-spec - v1.4.1

    Type Alias VectorFeatures

    VectorFeatures: VectorFeature | S2Feature

    Any Vector Geometry type

    +
    diff --git a/docs/types/VectorGeometry.html b/docs/types/VectorGeometry.html index 6f60ee6..00b020a 100644 --- a/docs/types/VectorGeometry.html +++ b/docs/types/VectorGeometry.html @@ -1,2 +1,2 @@ -VectorGeometry | s2json-spec - v1.4.0

    Type Alias VectorGeometry

    VectorGeometry:
        | VectorPointGeometry
        | VectorMultiPointGeometry
        | VectorLineStringGeometry
        | VectorMultiLineStringGeometry
        | VectorPolygonGeometry
        | VectorMultiPolygonGeometry

    All possible geometry shapes

    -
    +VectorGeometry | s2json-spec - v1.4.1

    Type Alias VectorGeometry

    VectorGeometry:
        | VectorPointGeometry
        | VectorMultiPointGeometry
        | VectorLineStringGeometry
        | VectorMultiLineStringGeometry
        | VectorPolygonGeometry
        | VectorMultiPolygonGeometry

    All possible geometry shapes

    +
    diff --git a/docs/types/VectorGeometryType.html b/docs/types/VectorGeometryType.html index db239df..c981497 100644 --- a/docs/types/VectorGeometryType.html +++ b/docs/types/VectorGeometryType.html @@ -1,2 +1,2 @@ -VectorGeometryType | s2json-spec - v1.4.0

    Type Alias VectorGeometryType

    VectorGeometryType:
        | "Point"
        | "MultiPoint"
        | "LineString"
        | "MultiLineString"
        | "Polygon"
        | "MultiPolygon"

    All possible geometry types

    -
    +VectorGeometryType | s2json-spec - v1.4.1

    Type Alias VectorGeometryType

    VectorGeometryType:
        | "Point"
        | "MultiPoint"
        | "LineString"
        | "MultiLineString"
        | "Polygon"
        | "MultiPolygon"

    All possible geometry types

    +
    diff --git a/docs/types/VectorLineOffset.html b/docs/types/VectorLineOffset.html index 481e547..d7bafe4 100644 --- a/docs/types/VectorLineOffset.html +++ b/docs/types/VectorLineOffset.html @@ -1,2 +1,2 @@ -VectorLineOffset | s2json-spec - v1.4.0

    Type Alias VectorLineOffset

    VectorLineOffset: number

    An offset defines how far the starting line is from the original starting point pre-slice

    -
    +VectorLineOffset | s2json-spec - v1.4.1

    Type Alias VectorLineOffset

    VectorLineOffset: number

    An offset defines how far the starting line is from the original starting point pre-slice

    +
    diff --git a/docs/types/VectorLineString.html b/docs/types/VectorLineString.html index 99141d8..fd69615 100644 --- a/docs/types/VectorLineString.html +++ b/docs/types/VectorLineString.html @@ -1,2 +1,2 @@ -VectorLineString | s2json-spec - v1.4.0

    Type Alias VectorLineString

    VectorLineString: VectorPoint[]

    Definition of a Vector LineString

    -
    +VectorLineString | s2json-spec - v1.4.1

    Type Alias VectorLineString

    VectorLineString: VectorPoint[]

    Definition of a Vector LineString

    +
    diff --git a/docs/types/VectorLineStringGeometry.html b/docs/types/VectorLineStringGeometry.html index 9c1e348..9ea4d8d 100644 --- a/docs/types/VectorLineStringGeometry.html +++ b/docs/types/VectorLineStringGeometry.html @@ -1,2 +1,2 @@ -VectorLineStringGeometry | s2json-spec - v1.4.0

    Type Alias VectorLineStringGeometry

    VectorLineStringGeometry: VectorBaseGeometry<"LineString", VectorLineString, VectorLineOffset, BBOX>

    LineStringGeometry is a line

    -
    +VectorLineStringGeometry | s2json-spec - v1.4.1

    Type Alias VectorLineStringGeometry

    VectorLineStringGeometry: VectorBaseGeometry<"LineString", VectorLineString, VectorLineOffset, BBOX>

    LineStringGeometry is a line

    +
    diff --git a/docs/types/VectorMultiLineOffset.html b/docs/types/VectorMultiLineOffset.html index 68c209e..dcb58b6 100644 --- a/docs/types/VectorMultiLineOffset.html +++ b/docs/types/VectorMultiLineOffset.html @@ -1,2 +1,2 @@ -VectorMultiLineOffset | s2json-spec - v1.4.0

    Type Alias VectorMultiLineOffset

    VectorMultiLineOffset: VectorLineOffset[]

    A collection of offsets

    -
    +VectorMultiLineOffset | s2json-spec - v1.4.1

    Type Alias VectorMultiLineOffset

    VectorMultiLineOffset: VectorLineOffset[]

    A collection of offsets

    +
    diff --git a/docs/types/VectorMultiLineString.html b/docs/types/VectorMultiLineString.html index bfd0f23..b16bb23 100644 --- a/docs/types/VectorMultiLineString.html +++ b/docs/types/VectorMultiLineString.html @@ -1,2 +1,2 @@ -VectorMultiLineString | s2json-spec - v1.4.0

    Type Alias VectorMultiLineString

    VectorMultiLineString: VectorLineString[]

    Definition of a Vector MultiLineString

    -
    +VectorMultiLineString | s2json-spec - v1.4.1

    Type Alias VectorMultiLineString

    VectorMultiLineString: VectorLineString[]

    Definition of a Vector MultiLineString

    +
    diff --git a/docs/types/VectorMultiLineStringGeometry.html b/docs/types/VectorMultiLineStringGeometry.html index a54e2f2..c41becf 100644 --- a/docs/types/VectorMultiLineStringGeometry.html +++ b/docs/types/VectorMultiLineStringGeometry.html @@ -1,2 +1,2 @@ -VectorMultiLineStringGeometry | s2json-spec - v1.4.0

    Type Alias VectorMultiLineStringGeometry

    VectorMultiLineStringGeometry: VectorBaseGeometry<"MultiLineString", VectorMultiLineString, VectorMultiLineOffset, BBOX>

    MultiLineStringGeometry contians multiple lines

    -
    +VectorMultiLineStringGeometry | s2json-spec - v1.4.1

    Type Alias VectorMultiLineStringGeometry

    VectorMultiLineStringGeometry: VectorBaseGeometry<"MultiLineString", VectorMultiLineString, VectorMultiLineOffset, BBOX>

    MultiLineStringGeometry contians multiple lines

    +
    diff --git a/docs/types/VectorMultiPoint.html b/docs/types/VectorMultiPoint.html index 21f6c63..038b84f 100644 --- a/docs/types/VectorMultiPoint.html +++ b/docs/types/VectorMultiPoint.html @@ -1,2 +1,2 @@ -VectorMultiPoint | s2json-spec - v1.4.0

    Type Alias VectorMultiPoint

    VectorMultiPoint: VectorPoint[]

    Definition of a Vector MultiPoint

    -
    +VectorMultiPoint | s2json-spec - v1.4.1

    Type Alias VectorMultiPoint

    VectorMultiPoint: VectorPoint[]

    Definition of a Vector MultiPoint

    +
    diff --git a/docs/types/VectorMultiPointGeometry.html b/docs/types/VectorMultiPointGeometry.html index 4c0447a..23f622b 100644 --- a/docs/types/VectorMultiPointGeometry.html +++ b/docs/types/VectorMultiPointGeometry.html @@ -1,2 +1,2 @@ -VectorMultiPointGeometry | s2json-spec - v1.4.0

    Type Alias VectorMultiPointGeometry

    VectorMultiPointGeometry: VectorBaseGeometry<"MultiPoint", VectorMultiPoint, undefined, BBOX>

    MultiPointGeometry contains multiple points

    -
    +VectorMultiPointGeometry | s2json-spec - v1.4.1

    Type Alias VectorMultiPointGeometry

    VectorMultiPointGeometry: VectorBaseGeometry<"MultiPoint", VectorMultiPoint, undefined, BBOX>

    MultiPointGeometry contains multiple points

    +
    diff --git a/docs/types/VectorMultiPolygon.html b/docs/types/VectorMultiPolygon.html index b0fac16..339a4f6 100644 --- a/docs/types/VectorMultiPolygon.html +++ b/docs/types/VectorMultiPolygon.html @@ -1,2 +1,2 @@ -VectorMultiPolygon | s2json-spec - v1.4.0

    Type Alias VectorMultiPolygon

    VectorMultiPolygon: VectorPolygon[]

    Definition of a Vector MultiPolygon

    -
    +VectorMultiPolygon | s2json-spec - v1.4.1

    Type Alias VectorMultiPolygon

    VectorMultiPolygon: VectorPolygon[]

    Definition of a Vector MultiPolygon

    +
    diff --git a/docs/types/VectorMultiPolygonGeometry.html b/docs/types/VectorMultiPolygonGeometry.html index dadb02c..e278819 100644 --- a/docs/types/VectorMultiPolygonGeometry.html +++ b/docs/types/VectorMultiPolygonGeometry.html @@ -1,2 +1,2 @@ -VectorMultiPolygonGeometry | s2json-spec - v1.4.0

    Type Alias VectorMultiPolygonGeometry

    VectorMultiPolygonGeometry: VectorBaseGeometry<"MultiPolygon", VectorMultiPolygon, VectorMultiPolygonOffset, BBOX>

    MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes

    -
    +VectorMultiPolygonGeometry | s2json-spec - v1.4.1

    Type Alias VectorMultiPolygonGeometry

    VectorMultiPolygonGeometry: VectorBaseGeometry<"MultiPolygon", VectorMultiPolygon, VectorMultiPolygonOffset, BBOX>

    MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes

    +
    diff --git a/docs/types/VectorMultiPolygonOffset.html b/docs/types/VectorMultiPolygonOffset.html index 16f99d4..4b4411e 100644 --- a/docs/types/VectorMultiPolygonOffset.html +++ b/docs/types/VectorMultiPolygonOffset.html @@ -1,2 +1,2 @@ -VectorMultiPolygonOffset | s2json-spec - v1.4.0

    Type Alias VectorMultiPolygonOffset

    VectorMultiPolygonOffset: VectorPolygonOffset[]

    A collection of collections of offsets

    -
    +VectorMultiPolygonOffset | s2json-spec - v1.4.1

    Type Alias VectorMultiPolygonOffset

    VectorMultiPolygonOffset: VectorPolygonOffset[]

    A collection of collections of offsets

    +
    diff --git a/docs/types/VectorOffsets.html b/docs/types/VectorOffsets.html index 1bb7f11..eb0774a 100644 --- a/docs/types/VectorOffsets.html +++ b/docs/types/VectorOffsets.html @@ -1,2 +1,2 @@ -VectorOffsets | s2json-spec - v1.4.0

    Type Alias VectorOffsets

    VectorOffsets:
        | VectorLineOffset
        | VectorMultiLineOffset
        | VectorPolygonOffset
        | VectorMultiPolygonOffset

    All possible geometry offsets

    -
    +VectorOffsets | s2json-spec - v1.4.1

    Type Alias VectorOffsets

    VectorOffsets:
        | VectorLineOffset
        | VectorMultiLineOffset
        | VectorPolygonOffset
        | VectorMultiPolygonOffset

    All possible geometry offsets

    +
    diff --git a/docs/types/VectorPointGeometry.html b/docs/types/VectorPointGeometry.html index f6b0676..4f82bad 100644 --- a/docs/types/VectorPointGeometry.html +++ b/docs/types/VectorPointGeometry.html @@ -1,2 +1,2 @@ -VectorPointGeometry | s2json-spec - v1.4.0

    Type Alias VectorPointGeometry

    VectorPointGeometry: VectorBaseGeometry<"Point", VectorPoint, undefined, BBOX>

    PointGeometry is a point

    -
    +VectorPointGeometry | s2json-spec - v1.4.1

    Type Alias VectorPointGeometry

    VectorPointGeometry: VectorBaseGeometry<"Point", VectorPoint, undefined, BBOX>

    PointGeometry is a point

    +
    diff --git a/docs/types/VectorPolygon.html b/docs/types/VectorPolygon.html index fcdbcd3..1d65b92 100644 --- a/docs/types/VectorPolygon.html +++ b/docs/types/VectorPolygon.html @@ -1,2 +1,2 @@ -VectorPolygon | s2json-spec - v1.4.0

    Type Alias VectorPolygon

    VectorPolygon: VectorLineString[]

    Definition of a Vector Polygon

    -
    +VectorPolygon | s2json-spec - v1.4.1

    Type Alias VectorPolygon

    VectorPolygon: VectorLineString[]

    Definition of a Vector Polygon

    +
    diff --git a/docs/types/VectorPolygonGeometry.html b/docs/types/VectorPolygonGeometry.html index 6714c41..a380b6c 100644 --- a/docs/types/VectorPolygonGeometry.html +++ b/docs/types/VectorPolygonGeometry.html @@ -1,2 +1,2 @@ -VectorPolygonGeometry | s2json-spec - v1.4.0

    Type Alias VectorPolygonGeometry

    VectorPolygonGeometry: VectorBaseGeometry<"Polygon", VectorPolygon, VectorPolygonOffset, BBOX>

    PolygonGeometry is a polygon with potential holes

    -
    +VectorPolygonGeometry | s2json-spec - v1.4.1

    Type Alias VectorPolygonGeometry

    VectorPolygonGeometry: VectorBaseGeometry<"Polygon", VectorPolygon, VectorPolygonOffset, BBOX>

    PolygonGeometry is a polygon with potential holes

    +
    diff --git a/docs/types/VectorPolygonOffset.html b/docs/types/VectorPolygonOffset.html index 4a27242..688838f 100644 --- a/docs/types/VectorPolygonOffset.html +++ b/docs/types/VectorPolygonOffset.html @@ -1,2 +1,2 @@ -VectorPolygonOffset | s2json-spec - v1.4.0

    Type Alias VectorPolygonOffset

    VectorPolygonOffset: VectorLineOffset[]

    A collection of offsets

    -
    +VectorPolygonOffset | s2json-spec - v1.4.1

    Type Alias VectorPolygonOffset

    VectorPolygonOffset: VectorLineOffset[]

    A collection of offsets

    +
    diff --git a/docs/variables/A.html b/docs/variables/A.html index 43c7551..cfb6635 100644 --- a/docs/variables/A.html +++ b/docs/variables/A.html @@ -1,2 +1,2 @@ -A | s2json-spec - v1.4.0

    Variable AConst

    A: 6378137 = 6_378_137.0

    900913 (Web Mercator) constant

    -
    +A | s2json-spec - v1.4.1

    Variable AConst

    A: 6378137 = 6_378_137.0

    900913 (Web Mercator) constant

    +
    diff --git a/docs/variables/EARTH_CIRCUMFERENCE.html b/docs/variables/EARTH_CIRCUMFERENCE.html index fdb91b5..cc4acf5 100644 --- a/docs/variables/EARTH_CIRCUMFERENCE.html +++ b/docs/variables/EARTH_CIRCUMFERENCE.html @@ -1,2 +1,2 @@ -EARTH_CIRCUMFERENCE | s2json-spec - v1.4.0

    Variable EARTH_CIRCUMFERENCEConst

    EARTH_CIRCUMFERENCE: number = ...

    The average circumference of the world in meters.

    -
    +EARTH_CIRCUMFERENCE | s2json-spec - v1.4.1

    Variable EARTH_CIRCUMFERENCEConst

    EARTH_CIRCUMFERENCE: number = ...

    The average circumference of the world in meters.

    +
    diff --git a/docs/variables/EARTH_RADIUS.html b/docs/variables/EARTH_RADIUS.html index 8b87a83..9f103c4 100644 --- a/docs/variables/EARTH_RADIUS.html +++ b/docs/variables/EARTH_RADIUS.html @@ -1,2 +1,2 @@ -EARTH_RADIUS | s2json-spec - v1.4.0

    Variable EARTH_RADIUSConst

    EARTH_RADIUS: 6371008.8 = 6_371_008.8

    Earth's radius in meters

    -
    +EARTH_RADIUS | s2json-spec - v1.4.1

    Variable EARTH_RADIUSConst

    EARTH_RADIUS: 6371008.8 = 6_371_008.8

    Earth's radius in meters

    +
    diff --git a/docs/variables/EARTH_RADIUS_EQUATORIAL.html b/docs/variables/EARTH_RADIUS_EQUATORIAL.html index 324afd4..fbcc9cb 100644 --- a/docs/variables/EARTH_RADIUS_EQUATORIAL.html +++ b/docs/variables/EARTH_RADIUS_EQUATORIAL.html @@ -1,2 +1,2 @@ -EARTH_RADIUS_EQUATORIAL | s2json-spec - v1.4.0

    Variable EARTH_RADIUS_EQUATORIALConst

    EARTH_RADIUS_EQUATORIAL: 6378137 = 6_378_137

    Earth's equitorial radius in meters

    -
    +EARTH_RADIUS_EQUATORIAL | s2json-spec - v1.4.1

    Variable EARTH_RADIUS_EQUATORIALConst

    EARTH_RADIUS_EQUATORIAL: 6378137 = 6_378_137

    Earth's equitorial radius in meters

    +
    diff --git a/docs/variables/EARTH_RADIUS_POLAR.html b/docs/variables/EARTH_RADIUS_POLAR.html index d95b266..d84c1b3 100644 --- a/docs/variables/EARTH_RADIUS_POLAR.html +++ b/docs/variables/EARTH_RADIUS_POLAR.html @@ -1,2 +1,2 @@ -EARTH_RADIUS_POLAR | s2json-spec - v1.4.0

    Variable EARTH_RADIUS_POLARConst

    EARTH_RADIUS_POLAR: 6356752.3 = 6_356_752.3

    Earth's polar radius in meters

    -
    +EARTH_RADIUS_POLAR | s2json-spec - v1.4.1

    Variable EARTH_RADIUS_POLARConst

    EARTH_RADIUS_POLAR: 6356752.3 = 6_356_752.3

    Earth's polar radius in meters

    +
    diff --git a/docs/variables/MARS_RADIUS.html b/docs/variables/MARS_RADIUS.html index 2359081..ebbd200 100644 --- a/docs/variables/MARS_RADIUS.html +++ b/docs/variables/MARS_RADIUS.html @@ -1,2 +1,2 @@ -MARS_RADIUS | s2json-spec - v1.4.0

    Variable MARS_RADIUSConst

    MARS_RADIUS: 3389500 = 3_389_500

    Mars' radius in meters

    -
    +MARS_RADIUS | s2json-spec - v1.4.1

    Variable MARS_RADIUSConst

    MARS_RADIUS: 3389500 = 3_389_500

    Mars' radius in meters

    +
    diff --git a/docs/variables/MARS_RADIUS_EQUATORIAL.html b/docs/variables/MARS_RADIUS_EQUATORIAL.html index 1a79a21..b6c7c87 100644 --- a/docs/variables/MARS_RADIUS_EQUATORIAL.html +++ b/docs/variables/MARS_RADIUS_EQUATORIAL.html @@ -1,2 +1,2 @@ -MARS_RADIUS_EQUATORIAL | s2json-spec - v1.4.0

    Variable MARS_RADIUS_EQUATORIALConst

    MARS_RADIUS_EQUATORIAL: 3396200 = 3_396_200

    Mars' equitorial radius in meters

    -
    +MARS_RADIUS_EQUATORIAL | s2json-spec - v1.4.1

    Variable MARS_RADIUS_EQUATORIALConst

    MARS_RADIUS_EQUATORIAL: 3396200 = 3_396_200

    Mars' equitorial radius in meters

    +
    diff --git a/docs/variables/MARS_RADIUS_POLAR.html b/docs/variables/MARS_RADIUS_POLAR.html index 47dedb5..bd94153 100644 --- a/docs/variables/MARS_RADIUS_POLAR.html +++ b/docs/variables/MARS_RADIUS_POLAR.html @@ -1,2 +1,2 @@ -MARS_RADIUS_POLAR | s2json-spec - v1.4.0

    Variable MARS_RADIUS_POLARConst

    MARS_RADIUS_POLAR: 3376200 = 3_376_200

    Mars' polar radius in meters

    -
    +MARS_RADIUS_POLAR | s2json-spec - v1.4.1

    Variable MARS_RADIUS_POLARConst

    MARS_RADIUS_POLAR: 3376200 = 3_376_200

    Mars' polar radius in meters

    +
    diff --git a/docs/variables/MAXEXTENT.html b/docs/variables/MAXEXTENT.html index 97fcc3e..99b2c37 100644 --- a/docs/variables/MAXEXTENT.html +++ b/docs/variables/MAXEXTENT.html @@ -1,2 +1,2 @@ -MAXEXTENT | s2json-spec - v1.4.0

    Variable MAXEXTENTConst

    MAXEXTENT: 20037508.342789244 = 20_037_508.342789244

    900913 (Web Mercator) max extent

    -
    +MAXEXTENT | s2json-spec - v1.4.1

    Variable MAXEXTENTConst

    MAXEXTENT: 20037508.342789244 = 20_037_508.342789244

    900913 (Web Mercator) max extent

    +
    diff --git a/docs/variables/MAXLAT.html b/docs/variables/MAXLAT.html index b25f080..22970c2 100644 --- a/docs/variables/MAXLAT.html +++ b/docs/variables/MAXLAT.html @@ -1,2 +1,2 @@ -MAXLAT | s2json-spec - v1.4.0

    Variable MAXLATConst

    MAXLAT: 85.0511287798 = 85.0511287798

    900913 (Web Mercator) maximum latitude

    -
    +MAXLAT | s2json-spec - v1.4.1

    Variable MAXLATConst

    MAXLAT: 85.0511287798 = 85.0511287798

    900913 (Web Mercator) maximum latitude

    +
    diff --git a/package.json b/package.json index 7b23ab4..0b293a0 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "s2json-spec", "publisher": "OpenS2", - "version": "1.4.0", + "version": "1.4.1", "description": "S2JSON is a specification for encoding a variety of geographic data structures", "keywords": [ "vector", diff --git a/src/s2json.schema.json b/src/s2json.schema.json index 9a701f4..9b45ca9 100644 --- a/src/s2json.schema.json +++ b/src/s2json.schema.json @@ -4,6 +4,7 @@ "oneOf": [ { "$ref": "#/definitions/FeatureCollection" }, { "$ref": "#/definitions/Feature" }, + { "$ref": "#/definitions/VectorFeature" }, { "$ref": "#/definitions/S2FeatureCollection" }, { "$ref": "#/definitions/S2Feature" } ], @@ -14,9 +15,9 @@ "type": { "type": "string", "enum": ["FeatureCollection"] }, "features": { "type": "array", - "items": { "$ref": "#/definitions/Feature" } + "items": { "oneOf": [{ "$ref": "#/definitions/Feature" }, { "$ref": "#/definitions/VectorFeature" }] } }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 } + "bbox": { "$ref": "#/definitions/bbox2D" } }, "required": ["type", "features"], "additionalProperties": false @@ -29,7 +30,7 @@ "type": "array", "items": { "$ref": "#/definitions/S2Feature" } }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, + "bbox": { "$ref": "#/definitions/bbox2D" }, "faces": { "type": "array", "items": { "type": "number", "enum": [0, 1, 2, 3, 4, 5] }, "uniqueItems": true, "maxItems": 6 } }, "required": ["type", "features", "faces"], @@ -41,7 +42,19 @@ "id": { "type": "number", "minimum": 0 }, "type": { "type": "string", "enum": ["Feature"] }, "geometry": { "$ref": "#/definitions/geometry" }, - "properties": { "type": "object" }, + "properties": { "$ref": "#/definitions/properties" }, + "metadata": { "type": "object" } + }, + "required": ["type", "geometry", "properties"], + "additionalProperties": false + }, + "VectorFeature": { + "type": "object", + "properties": { + "id": { "type": "number", "minimum": 0 }, + "type": { "type": "string", "enum": ["VectorFeature"] }, + "geometry": { "$ref": "#/definitions/vectorGeometry" }, + "properties": { "$ref": "#/definitions/properties" }, "metadata": { "type": "object" } }, "required": ["type", "geometry", "properties"], @@ -52,7 +65,7 @@ "properties": { "id": { "type": "number", "minimum": 0 }, "type": { "type": "string", "enum": ["S2Feature"] }, - "geometry": { "$ref": "#/definitions/geometry" }, + "geometry": { "$ref": "#/definitions/vectorGeometry" }, "properties": { "$ref": "#/definitions/properties" }, "face": { "type": "number", "enum": [0, 1, 2, 3, 4, 5] }, "metadata": { "type": "object" } @@ -113,6 +126,18 @@ { "$ref": "#/definitions/MultiPolygon3DGeometry" } ] }, + "vectorGeometry": { + "oneOf": [ + { "$ref": "#/definitions/VectorPointGeometry" }, + { "$ref": "#/definitions/VectorMultiPointGeometry" }, + { "$ref": "#/definitions/VectorLineStringGeometry" }, + { "$ref": "#/definitions/VectorMultiLineStringGeometry" }, + { "$ref": "#/definitions/VectorPolygonGeometry" }, + { "$ref": "#/definitions/VectorMultiPolygonGeometry" } + ] + }, + "bbox2D": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, + "bbox3D": { "type": "array", "items": { "type": "number" }, "minItems": 6, "maxItems": 6 }, "point": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "point3D": { "type": "array", "items": { "type": "number" }, "minItems": 3, "maxItems": 3 }, "multiPoint": { "type": "array", "items": { "$ref": "#/definitions/point" } }, @@ -135,7 +160,7 @@ "properties": { "type": { "type": "string", "enum": ["Point"] }, "coordinates": { "$ref": "#/definitions/point" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, + "bbox": { "$ref": "#/definitions/bbox2D" }, "mValues": { "$ref": "#/definitions/mValue" } }, "required": ["type", "coordinates"], @@ -146,7 +171,7 @@ "properties": { "type": { "type": "string", "enum": ["MultiPoint"] }, "coordinates": { "$ref": "#/definitions/multiPoint" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, + "bbox": { "$ref": "#/definitions/bbox2D" }, "mValues": { "$ref": "#/definitions/mValueMultiPoint" } }, "required": ["type", "coordinates"], @@ -157,7 +182,7 @@ "properties": { "type": { "type": "string", "enum": ["LineString"] }, "coordinates": { "$ref": "#/definitions/line" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, + "bbox": { "$ref": "#/definitions/bbox2D" }, "mValues": { "$ref": "#/definitions/mValueLine" } }, "required": ["type", "coordinates"], @@ -168,7 +193,7 @@ "properties": { "type": { "type": "string", "enum": ["MultiLineString"] }, "coordinates": { "$ref": "#/definitions/multiLine" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, + "bbox": { "$ref": "#/definitions/bbox2D" }, "mValues": { "$ref": "#/definitions/mValueMultiLine" } }, "required": ["type", "coordinates"], @@ -179,7 +204,7 @@ "properties": { "type": { "type": "string", "enum": ["Polygon"] }, "coordinates": { "$ref": "#/definitions/polygon" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, + "bbox": { "$ref": "#/definitions/bbox2D" }, "mValues": { "$ref": "#/definitions/mValuePolygon" } }, "required": ["type", "coordinates"], @@ -190,7 +215,7 @@ "properties": { "type": { "type": "string", "enum": ["MultiPolygon"] }, "coordinates": { "$ref": "#/definitions/multiPolygon" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 4, "maxItems": 4 }, + "bbox": { "$ref": "#/definitions/bbox2D" }, "mValues": { "$ref": "#/definitions/mValueMultiPolygon" } }, "required": ["type", "coordinates"], @@ -201,7 +226,7 @@ "properties": { "type": { "type": "string", "enum": ["Point3D"] }, "coordinates": { "$ref": "#/definitions/point3D" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 6, "maxItems": 6 }, + "bbox": { "$ref": "#/definitions/bbox3D" }, "mValues": { "$ref": "#/definitions/mValue" } }, "required": ["type", "coordinates"], @@ -212,7 +237,7 @@ "properties": { "type": { "type": "string", "enum": ["MultiPoint3D"] }, "coordinates": { "$ref": "#/definitions/multiPoint3D" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 6, "maxItems": 6 }, + "bbox": { "$ref": "#/definitions/bbox3D" }, "mValues": { "$ref": "#/definitions/mValueMultiPoint" } }, "required": ["type", "coordinates"], @@ -223,7 +248,7 @@ "properties": { "type": { "type": "string", "enum": ["LineString3D"] }, "coordinates": { "$ref": "#/definitions/line3D" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 6, "maxItems": 6 }, + "bbox": { "$ref": "#/definitions/bbox3D" }, "mValues": { "$ref": "#/definitions/mValueLine" } }, "required": ["type", "coordinates"], @@ -234,7 +259,7 @@ "properties": { "type": { "type": "string", "enum": ["MultiLineString3D"] }, "coordinates": { "$ref": "#/definitions/multiLine3D" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 6, "maxItems": 6 }, + "bbox": { "$ref": "#/definitions/bbox3D" }, "mValues": { "$ref": "#/definitions/mValueMultiLine" } }, "required": ["type", "coordinates"], @@ -245,7 +270,7 @@ "properties": { "type": { "type": "string", "enum": ["Polygon3D"] }, "coordinates": { "$ref": "#/definitions/polygon3D" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 6, "maxItems": 6 }, + "bbox": { "$ref": "#/definitions/bbox3D" }, "mValues": { "$ref": "#/definitions/mValuePolygon" } }, "required": ["type", "coordinates"], @@ -256,11 +281,102 @@ "properties": { "type": { "type": "string", "enum": ["MultiPolygon3D"] }, "coordinates": { "$ref": "#/definitions/multiPolygon3D" }, - "bbox": { "type": "array", "items": { "type": "number" }, "minItems": 6, "maxItems": 6 }, + "bbox": { "$ref": "#/definitions/bbox3D" }, "mValues": { "$ref": "#/definitions/mValueMultiPoint" } }, "required": ["type", "coordinates"], "additionalProperties": false + }, + "vectorLineOffset": { "type": "number" }, + "vectorMultiLineOffset": { "type": "array", "items": { "$ref": "#/definitions/vectorLineOffset" } }, + "vectorPolygonOffset": { "type": "array", "items": { "$ref": "#/definitions/vectorLineOffset" } }, + "vectorMultiPolygonOffset": { "type": "array", "items": { "$ref": "#/definitions/vectorPolygonOffset" } }, + "vectorPoint": { + "type": "object", + "properties": { + "x": { "type": "number" }, + "y": { "type": "number" }, + "z": { "type": "number" }, + "m": { "$ref": "#/definitions/mValue" }, + "t": { "type": "number" } + }, + "required": ["x", "y"], + "additionalProperties": false + }, + "vectorMultiPoint": { "type": "array", "items": { "$ref": "#/definitions/vectorPoint" } }, + "vectorLine": { "type": "array", "items": { "$ref": "#/definitions/vectorPoint" } }, + "vectorMultiLine": { "type": "array", "items": { "$ref": "#/definitions/vectorLine" } }, + "vectorPolygon": { "type": "array", "items": { "$ref": "#/definitions/vectorLine" } }, + "vectorMultiPolygon": { "type": "array", "items": { "$ref": "#/definitions/vectorPolygon" } }, + "VectorPointGeometry": { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["Point"] }, + "coordinates": { "$ref": "#/definitions/vectorPoint" }, + "bbox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "vecBBox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] } + }, + "required": ["type", "coordinates"], + "additionalProperties": false + }, + "VectorMultiPointGeometry": { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["MultiPoint"] }, + "coordinates": { "$ref": "#/definitions/vectorMultiPoint" }, + "bbox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "vecBBox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] } + }, + "required": ["type", "coordinates"], + "additionalProperties": false + }, + "VectorLineStringGeometry": { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["LineString"] }, + "coordinates": { "$ref": "#/definitions/vectorLine" }, + "bbox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "vecBBox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "offset": { "$ref": "#/definitions/vectorLineOffset" } + }, + "required": ["type", "coordinates"], + "additionalProperties": false + }, + "VectorMultiLineStringGeometry": { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["MultiLineString"] }, + "coordinates": { "$ref": "#/definitions/vectorMultiLine" }, + "bbox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "vecBBox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "offset": { "$ref": "#/definitions/vectorMultiLineOffset" } + }, + "required": ["type", "coordinates"], + "additionalProperties": false + }, + "VectorPolygonGeometry": { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["Polygon"] }, + "coordinates": { "$ref": "#/definitions/vectorPolygon" }, + "bbox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "vecBBox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "offset": { "$ref": "#/definitions/vectorPolygonOffset" } + }, + "required": ["type", "coordinates"], + "additionalProperties": false + }, + "VectorMultiPolygonGeometry": { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["MultiPolygon"] }, + "coordinates": { "$ref": "#/definitions/vectorMultiPolygon" }, + "bbox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "vecBBox": { "oneOf": [{ "$ref": "#/definitions/bbox2D" }, { "$ref": "#/definitions/bbox3D" }] }, + "offset": { "$ref": "#/definitions/vectorMultiPolygonOffset" } + }, + "required": ["type", "coordinates"], + "additionalProperties": false } } } \ No newline at end of file diff --git a/test/index.test.ts b/test/index.test.ts deleted file mode 100644 index d961dc2..0000000 --- a/test/index.test.ts +++ /dev/null @@ -1,133 +0,0 @@ -import Ajv from 'ajv'; -import { describe, expect, it } from 'bun:test'; - -import schema from '../src/s2json.schema.json'; - -import type { Feature } from '../src'; - -const ajv = new Ajv(); -const validate = ajv.compile(schema); - -describe('feature', () => { - it('feature point', () => { - const validFeature: Feature = { - type: 'Feature', - geometry: { - type: 'Point', - coordinates: [-75.165222, 39.952583], - }, - properties: {}, - }; - expect(validate(validFeature)).toBeTrue(); - - const validFeatureWithOptionals: Feature = { - id: 0, - type: 'Feature', - geometry: { - type: 'Point', - coordinates: [-75.165222, 39.952583], - bbox: [-75.165222, 39.952583, -75.165222, 39.952583], - mValues: { a: 1 }, - }, - properties: { - name: 'Home', - }, - }; - expect(validate(validFeatureWithOptionals)).toBeTrue(); - - const badID: Feature = { - id: -2, - type: 'Feature', - geometry: { - type: 'Point', - coordinates: [-75.165222, 39.952583], - }, - properties: {}, - }; - expect(validate(badID)).toBeFalse(); - - // @ts-expect-error - no properties - const noProperties: Feature = { - type: 'Feature', - geometry: { - type: 'Point', - coordinates: [-75.165222, 39.952583], - }, - }; - expect(validate(noProperties)).toBeFalse(); - - // @ts-expect-error - no geometry - const noGeometry: Feature = { - type: 'Feature', - properties: {}, - }; - expect(validate(noGeometry)).toBeFalse(); - - // @ts-expect-error - no type - const noType: Feature = { - geometry: { - type: 'Point', - coordinates: [-75.165222, 39.952583], - }, - properties: {}, - }; - expect(validate(noType)).toBeFalse(); - - const badType: Feature = { - // @ts-expect-error - bad type - type: 'Point', - geometry: { - type: 'Point', - coordinates: [-75.165222, 39.952583], - }, - properties: {}, - }; - expect(validate(badType)).toBeFalse(); - - const badGeometryType: Feature = { - type: 'Feature', - geometry: { - // @ts-expect-error - bad geometry - type: 'Feature', - coordinates: [-75.165222, 39.952583], - }, - properties: {}, - }; - expect(validate(badGeometryType)).toBeFalse(); - - const badGeometryCoordinates: Feature = { - type: 'Feature', - geometry: { - type: 'Point', - // @ts-expect-error - bad geometry - coordinates: [[-75.165222, 39.952583]], - }, - properties: {}, - }; - expect(validate(badGeometryCoordinates)).toBeFalse(); - - const badGeometryBBox: Feature = { - type: 'Feature', - geometry: { - type: 'Point', - coordinates: [-75.165222, 39.952583], - // @ts-expect-error - bad geometry - bbox: [-75.165222, 39.952583, -75.165222, 39.952583, -75.165222], - }, - properties: {}, - }; - expect(validate(badGeometryBBox)).toBeFalse(); - - const badGeometryMValues: Feature = { - type: 'Feature', - // @ts-expect-error - bad geometry - geometry: { - type: 'Point', - coordinates: [-75.165222, 39.952583], - mValues: [{ a: 1 }], - }, - properties: {}, - }; - expect(validate(badGeometryMValues)).toBeFalse(); - }); -}); diff --git a/test/schema.test.ts b/test/schema.test.ts new file mode 100644 index 0000000..14d7044 --- /dev/null +++ b/test/schema.test.ts @@ -0,0 +1,395 @@ +import Ajv from 'ajv'; +import { describe, expect, it } from 'bun:test'; + +import schema from '../src/s2json.schema.json'; + +import type { Feature, S2Feature, VectorFeature } from '../src'; + +const ajv = new Ajv(); +const validate = ajv.compile(schema); + +describe('feature', () => { + it('feature point', () => { + const validFeature: Feature = { + type: 'Feature', + geometry: { + type: 'Point', + coordinates: [-75.165222, 39.952583], + }, + properties: {}, + }; + expect(validate(validFeature)).toBeTrue(); + + const validFeatureWithOptionals: Feature = { + id: 0, + type: 'Feature', + geometry: { + type: 'Point', + coordinates: [-75.165222, 39.952583], + bbox: [-75.165222, 39.952583, -75.165222, 39.952583], + mValues: { a: 1 }, + }, + properties: { + name: 'Home', + }, + }; + expect(validate(validFeatureWithOptionals)).toBeTrue(); + + const badID: Feature = { + id: -2, + type: 'Feature', + geometry: { + type: 'Point', + coordinates: [-75.165222, 39.952583], + }, + properties: {}, + }; + expect(validate(badID)).toBeFalse(); + + // @ts-expect-error - no properties + const noProperties: Feature = { + type: 'Feature', + geometry: { + type: 'Point', + coordinates: [-75.165222, 39.952583], + }, + }; + expect(validate(noProperties)).toBeFalse(); + + // @ts-expect-error - no geometry + const noGeometry: Feature = { + type: 'Feature', + properties: {}, + }; + expect(validate(noGeometry)).toBeFalse(); + + // @ts-expect-error - no type + const noType: Feature = { + geometry: { + type: 'Point', + coordinates: [-75.165222, 39.952583], + }, + properties: {}, + }; + expect(validate(noType)).toBeFalse(); + + const badType: Feature = { + // @ts-expect-error - bad type + type: 'Point', + geometry: { + type: 'Point', + coordinates: [-75.165222, 39.952583], + }, + properties: {}, + }; + expect(validate(badType)).toBeFalse(); + + const badGeometryType: Feature = { + type: 'Feature', + geometry: { + // @ts-expect-error - bad geometry + type: 'Feature', + coordinates: [-75.165222, 39.952583], + }, + properties: {}, + }; + expect(validate(badGeometryType)).toBeFalse(); + + const badGeometryCoordinates: Feature = { + type: 'Feature', + geometry: { + type: 'Point', + // @ts-expect-error - bad geometry + coordinates: [[-75.165222, 39.952583]], + }, + properties: {}, + }; + expect(validate(badGeometryCoordinates)).toBeFalse(); + + const badGeometryBBox: Feature = { + type: 'Feature', + geometry: { + type: 'Point', + coordinates: [-75.165222, 39.952583], + // @ts-expect-error - bad geometry + bbox: [-75.165222, 39.952583, -75.165222, 39.952583, -75.165222], + }, + properties: {}, + }; + expect(validate(badGeometryBBox)).toBeFalse(); + + const badGeometryMValues: Feature = { + type: 'Feature', + // @ts-expect-error - bad geometry + geometry: { + type: 'Point', + coordinates: [-75.165222, 39.952583], + mValues: [{ a: 1 }], + }, + properties: {}, + }; + expect(validate(badGeometryMValues)).toBeFalse(); + }); +}); + +describe('vector feature', () => { + it('feature point', () => { + const validFeature: VectorFeature = { + type: 'VectorFeature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(validFeature)).toBeTrue(); + + const validFeatureWithOptionals: VectorFeature = { + id: 0, + type: 'VectorFeature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583, m: { a: 1 } }, + bbox: [-75.165222, 39.952583, -75.165222, 39.952583], + }, + properties: { + name: 'Home', + }, + }; + expect(validate(validFeatureWithOptionals)).toBeTrue(); + + const badID: VectorFeature = { + id: -2, + type: 'VectorFeature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(badID)).toBeFalse(); + + // @ts-expect-error - no properties + const noProperties: VectorFeature = { + type: 'VectorFeature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + }; + expect(validate(noProperties)).toBeFalse(); + + // @ts-expect-error - no geometry + const noGeometry: VectorFeature = { + type: 'VectorFeature', + properties: {}, + }; + expect(validate(noGeometry)).toBeFalse(); + + // @ts-expect-error - no type + const noType: VectorFeature = { + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(noType)).toBeFalse(); + + const badType: VectorFeature = { + // @ts-expect-error - bad type + type: 'Point', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(badType)).toBeFalse(); + + const badGeometryType: VectorFeature = { + type: 'VectorFeature', + geometry: { + // @ts-expect-error - bad geometry + type: 'Feature', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(badGeometryType)).toBeFalse(); + + const badGeometryCoordinates: VectorFeature = { + type: 'VectorFeature', + // @ts-expect-error - bad geometry + geometry: { + type: 'Point', + coordinates: [{ x: -75.165222, y: 39.952583 }], + }, + properties: {}, + }; + expect(validate(badGeometryCoordinates)).toBeFalse(); + + const badGeometryBBox: VectorFeature = { + type: 'VectorFeature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + // @ts-expect-error - bad bounding box + bbox: [-75.165222, 39.952583, -75.165222, 39.952583, -75.165222], + }, + properties: {}, + }; + expect(validate(badGeometryBBox)).toBeFalse(); + + const badGeometryMValues: VectorFeature = { + type: 'VectorFeature', + geometry: { + type: 'Point', + // @ts-expect-error - bad m-value + coordinates: { x: -75.165222, y: 39.952583, m: [{ a: 1 }] }, + }, + properties: {}, + }; + expect(validate(badGeometryMValues)).toBeFalse(); + }); +}); + +describe('s2 feature', () => { + it('feature point', () => { + const validFeature: S2Feature = { + type: 'S2Feature', + face: 0, + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(validFeature)).toBeTrue(); + + const validFeatureWithOptionals: S2Feature = { + id: 0, + face: 0, + type: 'S2Feature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583, m: { a: 1 } }, + bbox: [-75.165222, 39.952583, -75.165222, 39.952583], + }, + properties: { + name: 'Home', + }, + }; + expect(validate(validFeatureWithOptionals)).toBeTrue(); + + const badID: S2Feature = { + // bad id + id: -2, + face: 0, + type: 'S2Feature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(badID)).toBeFalse(); + + // @ts-expect-error - no properties + const noProperties: S2Feature = { + type: 'S2Feature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + }; + expect(validate(noProperties)).toBeFalse(); + + // @ts-expect-error - no geometry + const noGeometry: S2Feature = { + type: 'S2Feature', + properties: {}, + }; + expect(validate(noGeometry)).toBeFalse(); + + // @ts-expect-error - no type + const noType: S2Feature = { + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(noType)).toBeFalse(); + + const badType: S2Feature = { + // @ts-expect-error - bad type + type: 'Point', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(badType)).toBeFalse(); + + const badGeometryType: S2Feature = { + type: 'S2Feature', + geometry: { + // @ts-expect-error - bad geometry + type: 'Feature', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(badGeometryType)).toBeFalse(); + + const badGeometryCoordinates: S2Feature = { + type: 'S2Feature', + // @ts-expect-error - bad geometry + geometry: { + type: 'Point', + coordinates: [{ x: -75.165222, y: 39.952583 }], + }, + properties: {}, + }; + expect(validate(badGeometryCoordinates)).toBeFalse(); + + const badGeometryBBox: S2Feature = { + type: 'S2Feature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + // @ts-expect-error - bad bounding box + bbox: [-75.165222, 39.952583, -75.165222, 39.952583, -75.165222], + }, + properties: {}, + }; + expect(validate(badGeometryBBox)).toBeFalse(); + + const badGeometryMValues: S2Feature = { + type: 'S2Feature', + face: 0, + geometry: { + type: 'Point', + // @ts-expect-error - bad m-value + coordinates: { x: -75.165222, y: 39.952583, m: [{ a: 1 }] }, + }, + properties: {}, + }; + expect(validate(badGeometryMValues)).toBeFalse(); + + const badFace: S2Feature = { + id: 0, + // @ts-expect-error - bad face + face: 10, + type: 'S2Feature', + geometry: { + type: 'Point', + coordinates: { x: -75.165222, y: 39.952583 }, + }, + properties: {}, + }; + expect(validate(badFace)).toBeFalse(); + }); +});