constructor

• new S2TilesStore(
      path: string,
      maxzoom?: number,
      compression?: Compression,
  ): S2TilesStore

  Parameters

  • path: string

    the location of the S2Tiles data
  • Optionalmaxzoom: number

    set the maxzoom if you're writing
  • Optionalcompression: Compression

    set the compression algorithm if you're writing

  Returns S2TilesStore

Readonlypath

commit

• commit(metadata: Metadata, tileCompression?: Compression): Promise<void>

  Finish writing by building the header with root and leaf directories

  Parameters

  • metadata: Metadata

    the metadata to store
  • OptionaltileCompression: Compression

    the compression algorithm that was used on the tiles [Default: None]

  Returns Promise<void>

getMetadata

• getMetadata(): Promise<Metadata>

  Get the metadata of the archive

  Returns Promise<Metadata>

  • the metadata of the archive

getTileS2

• getTileS2(
      face: Face,
      zoom: number,
      x: number,
      y: number,
  ): Promise<undefined | Uint8Array<ArrayBufferLike>>

  Get the bytes of the tile at the given (face, zoom, x, y) coordinates

  Parameters

  • face: Face

    the Open S2 projection face
  • zoom: number

    the zoom level of the tile
  • x: number

    the x coordinate of the tile
  • y: number

    the y coordinate of the tile

  Returns Promise<undefined | Uint8Array<ArrayBufferLike>>

  • the bytes of the tile at the given (face, zoom, x, y) coordinates, or undefined if the tile does not exist in the archive.

getTileWM

• getTileWM(
      zoom: number,
      x: number,
      y: number,
  ): Promise<undefined | Uint8Array<ArrayBufferLike>>

  Get the bytes of the tile at the given (zoom, x, y) coordinates

  Parameters

  • zoom: number

    the zoom level of the tile
  • x: number

    the x coordinate of the tile
  • y: number

    the y coordinate of the tile

  Returns Promise<undefined | Uint8Array<ArrayBufferLike>>

  • the bytes of the tile at the given (z, x, y) coordinates, or undefined if the tile does not exist in the archive.

hasTileS2

• hasTileS2(face: Face, zoom: number, x: number, y: number): Promise<boolean>

  Check if an S2 tile exists in the archive

  Parameters

  • face: Face

    the Open S2 projection face
  • zoom: number

    the zoom level of the tile
  • x: number

    the x coordinate of the tile
  • y: number

    the y coordinate of the tile

  Returns Promise<boolean>

  • true if the tile exists in the archive

hasTileWM

• hasTileWM(zoom: number, x: number, y: number): Promise<boolean>

  Check if a tile exists in the archive

  Parameters

  • zoom: number

    the zoom level of the tile
  • x: number

    the x coordinate of the tile
  • y: number

    the y coordinate of the tile

  Returns Promise<boolean>

  • true if the tile exists in the archive

putTile

• putTile(
      face: Face,
      zoom: number,
      x: number,
      y: number,
      data: Uint8Array,
  ): Promise<void>

  Write a tile to the S2Tiles file given its (face, zoom, x, y) coordinates.

  Parameters

  • face: Face

    the Open S2 projection face
  • zoom: number

    the zoom level
  • x: number

    the tile X coordinate
  • y: number

    the tile Y coordinate
  • data: Uint8Array

    the tile data to store

  Returns Promise<void>

setup

• setup(): Promise<void>

  Setup the reader

  Returns Promise<void>

writeTileS2

• writeTileS2(
      face: Face,
      zoom: number,
      x: number,
      y: number,
      data: Uint8Array,
  ): Promise<void>

  Write a tile to the S2Tiles file given its (face, zoom, x, y) coordinates.

  Parameters

  • face: Face

    the Open S2 projection face
  • zoom: number

    the zoom level
  • x: number

    the tile X coordinate
  • y: number

    the tile Y coordinate
  • data: Uint8Array

    the tile data to store

  Returns Promise<void>

writeTileWM

• writeTileWM(zoom: number, x: number, y: number, data: Uint8Array): Promise<void>

  Write a tile to the S2Tiles file given its (z, x, y) coordinates.

  Parameters

  • zoom: number

    the zoom level
  • x: number

    the tile X coordinate
  • y: number

    the tile Y coordinate
  • data: Uint8Array

    the tile data to store

  Returns Promise<void>