Skip to content

Improve types: mark _* props as private, refine property value type #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mourner merged 1 commit into from
Jun 18, 2025
Merged

Improve types: mark _* props as private, refine property value type #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ export class VectorTileFeature {
* @param {number} end
* @param {number} extent
* @param {string[]} keys
* @param {unknown[]} values
* @param {(number | string | boolean)[]} values
*/
constructor(pbf, end, extent, keys, values) {
// Public

/** @type {Record<string, unknown>} */
/** @type {Record<string, number | string | boolean>} */
this.properties = {};

this.extent = extent;
Expand All @@ -25,9 +25,13 @@ export class VectorTileFeature {
/** @type {number | undefined} */
this.id = undefined;

/** @private */
this._pbf = pbf;
/** @private */
this._geometry = -1;
/** @private */
this._keys = keys;
/** @private */
this._values = values;

pbf.readFields(readFeature, this, end);
Expand Down Expand Up @@ -212,6 +216,7 @@ function readFeature(tag, feature, pbf) {
if (tag === 1) feature.id = pbf.readVarint();
else if (tag === 2) readTag(pbf, feature);
else if (tag === 3) feature.type = /** @type {0 | 1 | 2 | 3} */ (pbf.readVarint());
// @ts-expect-error TS2341 deliberately accessing a private property
else if (tag === 4) feature._geometry = pbf.pos;
}

Expand All @@ -223,8 +228,10 @@ function readTag(pbf, feature) {
const end = pbf.readVarint() + pbf.pos;

while (pbf.pos < end) {
const key = feature._keys[pbf.readVarint()],
value = feature._values[pbf.readVarint()];
// @ts-expect-error TS2341 deliberately accessing a private property
const key = feature._keys[pbf.readVarint()];
// @ts-expect-error TS2341 deliberately accessing a private property
const value = feature._values[pbf.readVarint()];
feature.properties[key] = value;
}
}
Expand Down Expand Up @@ -282,16 +289,19 @@ export class VectorTileLayer {
this.extent = 4096;
this.length = 0;

// Private
/** @private */
this._pbf = pbf;

/** @type {string[]} */
/** @private
* @type {string[]} */
this._keys = [];

/** @type {unknown[]} */
/** @private
* @type {(number | string | boolean)[]} */
this._values = [];

/** @type {number[]} */
/** @private
* @type {number[]} */
this._features = [];

pbf.readFields(readLayer, this, end);
Expand Down Expand Up @@ -321,8 +331,11 @@ function readLayer(tag, layer, pbf) {
if (tag === 15) layer.version = pbf.readVarint();
else if (tag === 1) layer.name = pbf.readString();
else if (tag === 5) layer.extent = pbf.readVarint();
// @ts-expect-error TS2341 deliberately accessing a private property
else if (tag === 2) layer._features.push(pbf.pos);
// @ts-expect-error TS2341 deliberately accessing a private property
else if (tag === 3) layer._keys.push(pbf.readString());
// @ts-expect-error TS2341 deliberately accessing a private property
else if (tag === 4) layer._values.push(readValueMessage(pbf));
}

Expand All @@ -344,6 +357,9 @@ function readValueMessage(pbf) {
tag === 6 ? pbf.readSVarint() :
tag === 7 ? pbf.readBoolean() : null;
}
if (value == null) {
throw new Error('unknown feature value');
}

return value;
}
Expand Down
Loading