Skip to content

Commit

Permalink
v1.2.3
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelKreil committed Oct 27, 2024
1 parent ca58c35 commit 7493696
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ fs.writeFileSync('tile.' + header.tile_format, tile);
### Class: `Container`<a id="class_container"></a>

The `VersaTiles` class is a wrapper around a `.versatiles` container file. It provides methods\
to access tile data, metadata, and other properties within the container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L38">\[src]</a></sup>
to access tile data, metadata, and other properties within the container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L73">\[src]</a></sup>

#### Constructor: `new Container(source, options)`

Constructs a new instance of the VersaTiles class. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L59">\[src]</a></sup>
Constructs a new instance of the VersaTiles class. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L94">\[src]</a></sup>

**Parameters:**

Expand All @@ -44,15 +44,15 @@ Constructs a new instance of the VersaTiles class. <sup><a href="https://github.

#### Method: `getHeader()`

Asynchronously retrieves the header information from the `.versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L81">\[src]</a></sup>
Asynchronously retrieves the header information from the `.versatiles` container. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L116">\[src]</a></sup>

**Returns:** <code>Promise<[Header](#interface_header)></code>

#### Method: `getMetadata()`

Asynchronously retrieves the metadata associated with the `.versatiles` container.\
Metadata typically includes information about `vector_layers` for vector tiles.
If the container does not include metadata, this method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L128">\[src]</a></sup>
If the container does not include metadata, this method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L163">\[src]</a></sup>

**Returns:** <code>Promise\<undefined | string></code>

Expand All @@ -61,7 +61,7 @@ If the container does not include metadata, this method returns `null`. <sup><a
Asynchronously retrieves a specific tile's data as a Buffer. If the tile data is compressed as\
defined in the container header, the returned Buffer will contain the compressed data.
To obtain uncompressed data, use the `getTileUncompressed` method.
If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L155">\[src]</a></sup>
If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L190">\[src]</a></sup>

**Parameters:**

Expand All @@ -79,7 +79,7 @@ If the specified tile does not exist, the method returns `null`. <sup><a href="h
Asynchronously retrieves a specific tile's uncompressed data as a Buffer. This method first\
retrieves the compressed tile data using `getTile` and then decompresses it based on the
compression setting in the container header.
If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/b2d8999879a78431b230a775ba91e1b589ce6f64/src/index.ts#L203">\[src]</a></sup>
If the specified tile does not exist, the method returns `null`. <sup><a href="https://github.com/versatiles-org/node-versatiles-container/blob/ca58c3578fd471796f01f5af73b174e3a7f48b4e/src/index.ts#L238">\[src]</a></sup>

**Parameters:**

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@versatiles/container",
"version": "1.2.2",
"version": "1.2.3",
"description": "A client library for reading VersaTiles containers",
"scripts": {
"build": "rm -rf dist && tsc -p tsconfig.build.json",
Expand Down

0 comments on commit 7493696

Please sign in to comment.