diff --git a/docs/classes/DirCache.html b/docs/classes/DirCache.html index 55c8014..649c758 100644 --- a/docs/classes/DirCache.html +++ b/docs/classes/DirCache.html @@ -1,4 +1,4 @@ -DirCache | s2-pmtiles - v0.5.0

Class DirCache<K, V>

A cache of directories. +DirCache | s2-pmtiles - v1.0.0

Class DirCache<K, V>

A cache of directories. The key is the offset in the data and the value is the directory entries.

Type Parameters

Hierarchy

  • Map<K, V>
    • DirCache

Constructors

constructor

Methods

delete @@ -16,4 +16,4 @@

set

  • set(key, dir): this

  • Parameters

    • key: K

      the offset position in the data

    • dir: V

      the directory entries

    Returns this

    this

    -

Settings

Member Visibility

Theme

On This Page

constructordeletegetset
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructordeletegetset
\ No newline at end of file diff --git a/docs/classes/PMTilesReader.html b/docs/classes/PMTilesReader.html index c7bf02d..28e2d61 100644 --- a/docs/classes/PMTilesReader.html +++ b/docs/classes/PMTilesReader.html @@ -1,4 +1,4 @@ -PMTilesReader | s2-pmtiles - v0.5.0

Class PMTilesReader

The File reader is to be used by bun/node/deno on the local filesystem.

+PMTilesReader | s2-pmtiles - v1.0.0

Class PMTilesReader

The File reader is to be used by bun/node/deno on the local filesystem.

Constructors

constructor

Properties

path

Methods

getHeader @@ -12,7 +12,7 @@

Methods

getHeader

getMetadata

  • getMetadata(): Metadata

  • Returns Metadata

      +

getMetadata

  • getMetadata(): Promise<Metadata>

  • Returns Promise<Metadata>

    • the metadata of the archive

getTile

  • getTile(zoom, x, y): Promise<undefined | Uint8Array>

  • Parameters

    • zoom: number

      the zoom level of the tile

      @@ -28,4 +28,4 @@

    Returns Promise<undefined | Uint8Array>

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

Settings

Member Visibility

Theme

On This Page

constructorpathgetHeadergetMetadatagetTilegetTileS2
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorpathgetHeadergetMetadatagetTilegetTileS2
\ No newline at end of file diff --git a/docs/classes/PMTilesWriter.html b/docs/classes/PMTilesWriter.html index fc8cb1a..05e93b4 100644 --- a/docs/classes/PMTilesWriter.html +++ b/docs/classes/PMTilesWriter.html @@ -1,4 +1,4 @@ -PMTilesWriter | s2-pmtiles - v0.5.0

Class PMTilesWriter

Write a PMTiles file.

+PMTilesWriter | s2-pmtiles - v1.0.0

Class PMTilesWriter

Write a PMTiles file.

Constructors

constructor

Properties

file type @@ -27,4 +27,4 @@
  • x: number

    the tile X coordinate

  • y: number

    the tile Y coordinate

  • data: Uint8Array

    the tile data to store

    -

    • Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorfiletypecommitwriteTilewriteTileS2writeTileXYZ
    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorfiletypecommitwriteTilewriteTileS2writeTileXYZ
    \ No newline at end of file diff --git a/docs/classes/S2PMTilesReader.html b/docs/classes/S2PMTilesReader.html index c9f1972..48b15f3 100644 --- a/docs/classes/S2PMTilesReader.html +++ b/docs/classes/S2PMTilesReader.html @@ -1,4 +1,4 @@ -S2PMTilesReader | s2-pmtiles - v0.5.0

    Class S2PMTilesReader

    The File reader is to be used by bun/node/deno on the local filesystem.

    +S2PMTilesReader | s2-pmtiles - v1.0.0

    Class S2PMTilesReader

    The File reader is to be used by bun/node/deno on the local filesystem.

    Constructors

    constructor

    Properties

    path rangeRequests @@ -31,4 +31,4 @@

    Returns Promise<undefined | Uint8Array>

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

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathrangeRequestsgetHeadergetMetadatagetTilegetTileS2
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpathrangeRequestsgetHeadergetMetadatagetTilegetTileS2
    \ No newline at end of file diff --git a/docs/enums/Compression.html b/docs/enums/Compression.html index 0952504..f460a7a 100644 --- a/docs/enums/Compression.html +++ b/docs/enums/Compression.html @@ -1,4 +1,4 @@ -Compression | s2-pmtiles - v0.5.0

    Enumeration Compression

    Enum representing a compression algorithm used. +Compression | s2-pmtiles - v1.0.0

    Enumeration Compression

    Enum representing a compression algorithm used. 0 = unknown compression, for if you must use a different or unspecified algorithm. 1 = no compression. 2 = gzip @@ -14,4 +14,4 @@

    None

    None: 1

    no compression.

    Unknown

    Unknown: 0

    unknown compression, for if you must use a different or unspecified algorithm.

    Zstd

    Zstd: 4

    zstd.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    BrotliGzipNoneUnknownZstd
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    BrotliGzipNoneUnknownZstd
    \ No newline at end of file diff --git a/docs/enums/TileType.html b/docs/enums/TileType.html index e21defd..9383db5 100644 --- a/docs/enums/TileType.html +++ b/docs/enums/TileType.html @@ -1,4 +1,4 @@ -TileType | s2-pmtiles - v0.5.0

    Enumeration TileType

    Describe the type of tiles stored in the archive. +TileType | s2-pmtiles - v1.0.0

    Enumeration TileType

    Describe the type of tiles stored in the archive. 0 is unknown/other, 1 is "MVT" vector tiles.

    Enumeration Members

    Avif Jpeg @@ -12,4 +12,4 @@

    Png

    Png: 2

    Image tiles.

    Unknown

    Unknown: 0

    unknown/other.

    Webp

    Webp: 4

    Image tiles.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    AvifJpegPbfPngUnknownWebp
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    AvifJpegPbfPngUnknownWebp
    \ No newline at end of file diff --git a/docs/functions/bytesToHeader.html b/docs/functions/bytesToHeader.html index 4d9bd7e..24862ab 100644 --- a/docs/functions/bytesToHeader.html +++ b/docs/functions/bytesToHeader.html @@ -1,4 +1,4 @@ -bytesToHeader | s2-pmtiles - v0.5.0

    Function bytesToHeader

    • bytesToHeader(bytes): Header

    • Parse raw header bytes into a Header object.

      +bytesToHeader | s2-pmtiles - v1.0.0

      Function bytesToHeader

      • bytesToHeader(bytes): Header

      • Parse raw header bytes into a Header object.

        Parameters

        • bytes: Uint8Array

          the raw header bytes

        Returns Header

        the parsed header

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/deserializeDir.html b/docs/functions/deserializeDir.html index 2e65462..1517bc4 100644 --- a/docs/functions/deserializeDir.html +++ b/docs/functions/deserializeDir.html @@ -1,5 +1,5 @@ -deserializeDir | s2-pmtiles - v0.5.0

    Function deserializeDir

    • deserializeDir(buffer): Entry[]

    • Parameters

      • buffer: Uint8Array

        the buffer to deserialize

        +deserializeDir | s2-pmtiles - v1.0.0

        Function deserializeDir

        • deserializeDir(buffer): Entry[]

        • Parameters

          • buffer: Uint8Array

            the buffer to deserialize

          Returns Entry[]

          • the deserialized entries
          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/findTile.html b/docs/functions/findTile.html index 574fb96..a2c3a2b 100644 --- a/docs/functions/findTile.html +++ b/docs/functions/findTile.html @@ -1,5 +1,5 @@ -findTile | s2-pmtiles - v0.5.0

    Function findTile

    • findTile(entries, tileID): Entry | null

    • Low-level function for looking up a TileID or leaf directory inside a directory.

      +findTile | s2-pmtiles - v1.0.0

      Function findTile

      • findTile(entries, tileID): Entry | null

      • Low-level function for looking up a TileID or leaf directory inside a directory.

        Parameters

        • entries: Entry[]

          the directory entries

        • tileID: number

          the tile ID

        Returns Entry | null

        the entry associated with the tile, or null if not found

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/getUint64.html b/docs/functions/getUint64.html index 022820d..4c8efe7 100644 --- a/docs/functions/getUint64.html +++ b/docs/functions/getUint64.html @@ -1,6 +1,6 @@ -getUint64 | s2-pmtiles - v0.5.0

    Function getUint64

    • getUint64(dv, offset): number

    • Parameters

      • dv: DataView

        a DataView

        +getUint64 | s2-pmtiles - v1.0.0

        Function getUint64

        • getUint64(dv, offset): number

        • Parameters

          • dv: DataView

            a DataView

          • offset: number

            the offset in the DataView

          Returns number

          • the decoded 64-bit number
          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/headerToBytes.html b/docs/functions/headerToBytes.html index 9435609..8ad4926 100644 --- a/docs/functions/headerToBytes.html +++ b/docs/functions/headerToBytes.html @@ -1,3 +1,3 @@ -headerToBytes | s2-pmtiles - v0.5.0

    Function headerToBytes

    • headerToBytes(header): Uint8Array

    • Parameters

      • header: Header

        the header object

        +headerToBytes | s2-pmtiles - v1.0.0

        Function headerToBytes

        • headerToBytes(header): Uint8Array

        • Parameters

          • header: Header

            the header object

          Returns Uint8Array

          the raw header bytes

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/readVarint.html b/docs/functions/readVarint.html index 7bc24e1..34521ea 100644 --- a/docs/functions/readVarint.html +++ b/docs/functions/readVarint.html @@ -1,5 +1,5 @@ -readVarint | s2-pmtiles - v0.5.0

    Function readVarint

    • readVarint(bufPos): number

    • Parameters

      • bufPos: BufferPosition

        the buffer with it's position

        +readVarint | s2-pmtiles - v1.0.0

        Function readVarint

        • readVarint(bufPos): number

        • Parameters

          Returns number

          • the decoded number
          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/readVarintRemainder.html b/docs/functions/readVarintRemainder.html index 50025f6..77bd870 100644 --- a/docs/functions/readVarintRemainder.html +++ b/docs/functions/readVarintRemainder.html @@ -1,6 +1,6 @@ -readVarintRemainder | s2-pmtiles - v0.5.0

    Function readVarintRemainder

    • readVarintRemainder(low, bufPos): number

    • Parameters

      • low: number

        the low 32 bits of the number

        +readVarintRemainder | s2-pmtiles - v1.0.0

        Function readVarintRemainder

        • readVarintRemainder(low, bufPos): number

        • Parameters

          • low: number

            the low 32 bits of the number

          • bufPos: BufferPosition

            the buffer with it's position

          Returns number

          • the decoded remainder
          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/s2BytesToHeader.html b/docs/functions/s2BytesToHeader.html index ec02793..58c751c 100644 --- a/docs/functions/s2BytesToHeader.html +++ b/docs/functions/s2BytesToHeader.html @@ -1,4 +1,4 @@ -s2BytesToHeader | s2-pmtiles - v0.5.0

    Function s2BytesToHeader

    • s2BytesToHeader(bytes): S2Header

    • Parse raw header bytes into a Header object.

      +s2BytesToHeader | s2-pmtiles - v1.0.0

      Function s2BytesToHeader

      • s2BytesToHeader(bytes): S2Header

      • Parse raw header bytes into a Header object.

        Parameters

        • bytes: Uint8Array

          the raw header bytes

        Returns S2Header

        the parsed header

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/s2HeaderToBytes.html b/docs/functions/s2HeaderToBytes.html index 8966160..5329ce4 100644 --- a/docs/functions/s2HeaderToBytes.html +++ b/docs/functions/s2HeaderToBytes.html @@ -1,3 +1,3 @@ -s2HeaderToBytes | s2-pmtiles - v0.5.0

    Function s2HeaderToBytes

    • s2HeaderToBytes(header): Uint8Array

    • Parameters

      • header: S2Header

        the header object

        +s2HeaderToBytes | s2-pmtiles - v1.0.0

        Function s2HeaderToBytes

        • s2HeaderToBytes(header): Uint8Array

        • Parameters

          Returns Uint8Array

          the raw header bytes

          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/serializeDir.html b/docs/functions/serializeDir.html index 9018112..b9f7f26 100644 --- a/docs/functions/serializeDir.html +++ b/docs/functions/serializeDir.html @@ -1,5 +1,5 @@ -serializeDir | s2-pmtiles - v0.5.0

    Function serializeDir

    • serializeDir(entries): Uint8Array

    • Parameters

      • entries: Entry[]

        the directory entries

        +serializeDir | s2-pmtiles - v1.0.0

        Function serializeDir

        • serializeDir(entries): Uint8Array

        • Parameters

          • entries: Entry[]

            the directory entries

          Returns Uint8Array

          • the serialized directory
          -

        Settings

        Member Visibility

        Theme

        \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/setUint64.html b/docs/functions/setUint64.html index 860fe1f..4ae511c 100644 --- a/docs/functions/setUint64.html +++ b/docs/functions/setUint64.html @@ -1,5 +1,5 @@ -setUint64 | s2-pmtiles - v0.5.0

    Function setUint64

    • setUint64(dv, offset, value): void

    • Take a large 64-bit number and encode it into a DataView

      +setUint64 | s2-pmtiles - v1.0.0

      Function setUint64

      • setUint64(dv, offset, value): void

      • Take a large 64-bit number and encode it into a DataView

        Parameters

        • dv: DataView

          a DataView

        • offset: number

          the offset in the DataView

        • value: number

          the encoded 64-bit number

          -

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/tileIDToZxy.html b/docs/functions/tileIDToZxy.html index f2f9014..ec8e0ff 100644 --- a/docs/functions/tileIDToZxy.html +++ b/docs/functions/tileIDToZxy.html @@ -1,6 +1,6 @@ -tileIDToZxy | s2-pmtiles - v0.5.0

    Function tileIDToZxy

    • tileIDToZxy(i): Tile

    • Convert a Hilbert TileID to Z,X,Y.

      +tileIDToZxy | s2-pmtiles - v1.0.0

      Function tileIDToZxy

      • tileIDToZxy(i): Tile

      • Convert a Hilbert TileID to Z,X,Y.

        Parameters

        • i: number

          the encoded tile ID

        Returns Tile

        • the decoded Z,X,Y
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/writeBigVarint.html b/docs/functions/writeBigVarint.html index ed4770b..ec9349f 100644 --- a/docs/functions/writeBigVarint.html +++ b/docs/functions/writeBigVarint.html @@ -1,4 +1,4 @@ -writeBigVarint | s2-pmtiles - v0.5.0

    Function writeBigVarint

    • writeBigVarint(val, bufPos): void

    • Write a varint larger then 54-bits.

      +writeBigVarint | s2-pmtiles - v1.0.0

      Function writeBigVarint

      • writeBigVarint(val, bufPos): void

      • Write a varint larger then 54-bits.

        Parameters

        • val: number

          the number

        • bufPos: BufferPosition

          the buffer with it's position to write at

          -

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/writeBigVarintHigh.html b/docs/functions/writeBigVarintHigh.html index 3490631..211eb12 100644 --- a/docs/functions/writeBigVarintHigh.html +++ b/docs/functions/writeBigVarintHigh.html @@ -1,4 +1,4 @@ -writeBigVarintHigh | s2-pmtiles - v0.5.0

    Function writeBigVarintHigh

    • writeBigVarintHigh(high, bufPos): void

    • Write a varint larger then 54-bits on the high end

      +writeBigVarintHigh | s2-pmtiles - v1.0.0

      Function writeBigVarintHigh

      • writeBigVarintHigh(high, bufPos): void

      • Write a varint larger then 54-bits on the high end

        Parameters

        • high: number

          the high 32 bits

        • bufPos: BufferPosition

          the buffer with it's position to write at

          -

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/writeBigVarintLow.html b/docs/functions/writeBigVarintLow.html index a7c7ab4..394851e 100644 --- a/docs/functions/writeBigVarintLow.html +++ b/docs/functions/writeBigVarintLow.html @@ -1,5 +1,5 @@ -writeBigVarintLow | s2-pmtiles - v0.5.0

    Function writeBigVarintLow

    • writeBigVarintLow(low, _high, bufPos): void

    • Write a varint larger then 54-bits on the low end

      +writeBigVarintLow | s2-pmtiles - v1.0.0

      Function writeBigVarintLow

      • writeBigVarintLow(low, _high, bufPos): void

      • Write a varint larger then 54-bits on the low end

        Parameters

        • low: number

          lower 32 bits

        • _high: number

          unused "high" bits

        • bufPos: BufferPosition

          the buffer with it's position to write at

          -

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/writeVarint.html b/docs/functions/writeVarint.html index 75f0fcc..064e390 100644 --- a/docs/functions/writeVarint.html +++ b/docs/functions/writeVarint.html @@ -1,5 +1,5 @@ -writeVarint | s2-pmtiles - v0.5.0

    Function writeVarint

    • writeVarint(val, bufPos): void

    • Write a varint. Can be max 64-bits. Numbers are coerced to an unsigned +writeVarint | s2-pmtiles - v1.0.0

      Function writeVarint

      • writeVarint(val, bufPos): void

      • Write a varint. Can be max 64-bits. Numbers are coerced to an unsigned while number before using this function.

        Parameters

        • val: number

          any whole unsigned number.

        • bufPos: BufferPosition

          the buffer with it's position to write at

          -

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/functions/zxyToTileID.html b/docs/functions/zxyToTileID.html index 3f8cad6..d3e7b6e 100644 --- a/docs/functions/zxyToTileID.html +++ b/docs/functions/zxyToTileID.html @@ -1,8 +1,8 @@ -zxyToTileID | s2-pmtiles - v0.5.0

    Function zxyToTileID

    • zxyToTileID(zoom, x, y): number

    • Convert Z,X,Y to a Hilbert TileID.

      +zxyToTileID | s2-pmtiles - v1.0.0

      Function zxyToTileID

      • zxyToTileID(zoom, x, y): number

      • Convert Z,X,Y to a Hilbert TileID.

        Parameters

        • zoom: number

          the zoom level

        • x: number

          the x coordinate

        • y: number

          the y coordinate

        Returns number

        • the Hilbert encoded TileID
        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index dab4897..94767c7 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -s2-pmtiles - v0.5.0

    s2-pmtiles - v0.5.0

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +s2-pmtiles - v1.0.0

    s2-pmtiles - v1.0.0

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 361c750..bf549e1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -s2-pmtiles - v0.5.0

    s2-pmtiles - v0.5.0

    +s2-pmtiles - v1.0.0

    s2-pmtiles - v1.0.0

    s2-pmtiles

    @@ -55,4 +55,4 @@

    Generating Coverage Report

    To generate the coverage report, use the following command:

    cargo tarpaulin
    # bacon
    bacon coverage # or type `l` inside the tool
    -

    Settings

    Member Visibility

    Theme

    On This Page

    AboutRead The SpecInstallDevelopment
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    AboutRead The SpecInstallDevelopment
    \ No newline at end of file diff --git a/docs/interfaces/BufferPosition.html b/docs/interfaces/BufferPosition.html index c9a7b7e..c626cb8 100644 --- a/docs/interfaces/BufferPosition.html +++ b/docs/interfaces/BufferPosition.html @@ -1,2 +1,2 @@ -BufferPosition | s2-pmtiles - v0.5.0

    Interface BufferPosition

    A buffer with the position to read from

    -
    interface BufferPosition {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +BufferPosition | s2-pmtiles - v1.0.0

    Interface BufferPosition

    A buffer with the position to read from

    +
    interface BufferPosition {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/Entry.html b/docs/interfaces/Entry.html index 7bc11a3..08d76a4 100644 --- a/docs/interfaces/Entry.html +++ b/docs/interfaces/Entry.html @@ -1,2 +1,2 @@ -Entry | s2-pmtiles - v0.5.0

    Interface Entry

    PMTiles v3 directory entry.

    -
    interface Entry {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Entry | s2-pmtiles - v1.0.0

    Interface Entry

    PMTiles v3 directory entry.

    +
    interface Entry {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/Header.html b/docs/interfaces/Header.html index 85a1a79..bd5557c 100644 --- a/docs/interfaces/Header.html +++ b/docs/interfaces/Header.html @@ -1,2 +1,2 @@ -Header | s2-pmtiles - v0.5.0

    Interface Header

    PMTiles v3 header storing basic archive-level information.

    -
    interface Header {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Header | s2-pmtiles - v1.0.0

    Interface Header

    PMTiles v3 header storing basic archive-level information.

    +
    interface Header {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/S2Entries.html b/docs/interfaces/S2Entries.html index f3fd918..879bcad 100644 --- a/docs/interfaces/S2Entries.html +++ b/docs/interfaces/S2Entries.html @@ -1,2 +1,2 @@ -S2Entries | s2-pmtiles - v0.5.0

    Interface S2Entries

    Store entries for each Face

    -
    interface S2Entries {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +S2Entries | s2-pmtiles - v1.0.0

    Interface S2Entries

    Store entries for each Face

    +
    interface S2Entries {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/S2Header.html b/docs/interfaces/S2Header.html index 7d3e9ee..51932c8 100644 --- a/docs/interfaces/S2Header.html +++ b/docs/interfaces/S2Header.html @@ -1,2 +1,2 @@ -S2Header | s2-pmtiles - v0.5.0

    Interface S2Header

    S2PMTiles v3 header storing basic archive-level information.

    -
    interface S2Header {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +S2Header | s2-pmtiles - v1.0.0

    Interface S2Header

    S2PMTiles v3 header storing basic archive-level information.

    +
    interface S2Header {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index d6d40e0..d64a7ae 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -s2-pmtiles - v0.5.0

    s2-pmtiles - v0.5.0

    Index

    Enumerations

    Compression +s2-pmtiles - v1.0.0

    s2-pmtiles - v1.0.0

    Index

    Enumerations

    Compression TileType

    Classes

    DirCache PMTilesReader @@ -29,4 +29,4 @@ writeBigVarintLow writeVarint zxyToTileID -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/DecompressFunc.html b/docs/types/DecompressFunc.html index 28e167d..d353f46 100644 --- a/docs/types/DecompressFunc.html +++ b/docs/types/DecompressFunc.html @@ -1,4 +1,4 @@ -DecompressFunc | s2-pmtiles - v0.5.0

    Type alias DecompressFunc

    DecompressFunc: ((buf, compression) => Promise<Uint8Array>)

    Provide a decompression implementation that acts on buf and returns decompressed data.

    +DecompressFunc | s2-pmtiles - v1.0.0

    Type alias DecompressFunc

    DecompressFunc: ((buf, compression) => Promise<Uint8Array>)

    Provide a decompression implementation that acts on buf and returns decompressed data.

    Should use the native DecompressionStream on browsers, zlib on node. Should throw if the compression algorithm is not supported.

    -

    Type declaration

      • (buf, compression): Promise<Uint8Array>

      • Parameters

        Returns Promise<Uint8Array>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (buf, compression): Promise<Uint8Array>

      • Parameters

        Returns Promise<Uint8Array>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/Point.html b/docs/types/Point.html index ebe5d82..530a892 100644 --- a/docs/types/Point.html +++ b/docs/types/Point.html @@ -1,2 +1,2 @@ -Point | s2-pmtiles - v0.5.0

    Type alias Point

    Point: [x: number, y: number]

    An array of two numbers representing a point in 2D space.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Point | s2-pmtiles - v1.0.0

    Type alias Point

    Point: [x: number, y: number]

    An array of two numbers representing a point in 2D space.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/Tile.html b/docs/types/Tile.html index 67fdde9..5d5790c 100644 --- a/docs/types/Tile.html +++ b/docs/types/Tile.html @@ -1,2 +1,2 @@ -Tile | s2-pmtiles - v0.5.0

    Type alias Tile

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

    A tile, in the format of ZXY.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Tile | s2-pmtiles - v1.0.0

    Type alias Tile

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

    A tile, in the format of ZXY.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/package.json b/package.json index 3163222..f689243 100644 --- a/package.json +++ b/package.json @@ -49,7 +49,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/Open-S2/s2-pmtiles.git" + "url": "git+https://github.com/Open-S2/s2-pmtiles.git" }, "author": "Craig OConnor", "license": "MIT",