fixup

Author: stepankuzmin

compile.js

@@ -12,7 +12,9 @@ export function compileRaw(proto, options = {}) {
 
     let output = options.dev ? '' : `// code generated by pbf v${version}\n`;
     if (options.jsDoc) {
-        output += typeDef(`import("${options.dev ? '../../index.js' : 'pbf'}").default`, 'Pbf');
+        output += options.dev ?
+            typeDef('import("../../index.js").default', 'Pbf') :
+            typeDef('import("pbf")', 'Pbf');
     }
     output += writeContext(context, options);
     return output;
@@ -42,7 +44,13 @@ function writeMessage(ctx, options) {
     if (!options.noRead) {
         const readName = `read${name}`;
         if (options.jsDoc) {
-            code += ['\n/**', ' * @param {Pbf} pbf', ' * @param {number} [end]', ` * @returns {${name}}`, ' */'].join('\n').concat('\n');
+            code += `
+/**
+ * @param {Pbf} pbf
+ * @param {number} [end]
+ * @returns {${name}}
+ */
+`;
         }
         code +=
 `${writeFunctionExport(options, readName)}function ${readName}(pbf, end) {
@@ -55,7 +63,13 @@ function writeMessage(ctx, options) {
                 const {key, value} = getMapTsType(fields);
                 param = `{key: ${key}; value: ${value}}`;
             }
-            code += ['\n/**', ' * @param {number} tag', ` * @param {${param}} obj`, ' * @param {Pbf} pbf', ' */'].join('\n').concat('\n');
+            code += `
+/**
+ * @param {number} tag
+ * @param {${param}} obj
+ * @param {Pbf} pbf
+ */
+`;
         }
         code +=
 `function ${readName}Field(tag, obj, pbf) {
@@ -93,7 +107,12 @@ function writeMessage(ctx, options) {
                 param = `{key: ${key}; value: ${value}}`;
             }
 
-            code += ['\n/**', ` * @param {${param}} obj`, ' * @param {Pbf} pbf', ' */'].join('\n').concat('\n');
+            code += `
+/**
+ * @param {${param}} obj
+ * @param {Pbf} pbf
+ */
+`;
         }
 
         code += `${writeFunctionExport(options, writeName)}function ${writeName}(obj, pbf) {\n`;
@@ -480,12 +499,6 @@ function getMapTsType(fields) {
     return {key, value};
 }
 
-/**
- * @param {string} type
- * @param {string} name
- * @param {{name: string; type: string; required: boolean}} [fields]
- * @returns {string}
- */
 function typeDef(type, name, fields = []) {
     const unionProperties = {};
     const properties = fields.map((field) => {
@@ -512,16 +525,10 @@ function typeDef(type, name, fields = []) {
         .concat('\n');
 }
 
-/**
- * @param {object} ctx
- * @param {string} name
- * @param {{name: string; type: string; required: boolean}} [fields]
- * @returns {string}
- */
 function compileType(ctx, name, fields = []) {
     if (ctx._proto.map) {
         const {key, value} = getMapTsType(fields);
-        return typeDef(`Object<${key}, ${value}>`, name, []);
+        return typeDef(`Record<${key}, ${value}>`, name, []);
     }
 
     const typedFields = fields.map((field) => {

test/fixtures/defaults_implicit.js

@@ -43,11 +43,11 @@ export function writeCustomType(obj, pbf) {
  * @property {boolean} [flag]
  * @property {number} [weight]
  * @property {number} [id]
- * @property {Array<string>} tags
- * @property {Array<number>} numbers
+ * @property {string[]} tags
+ * @property {number[]} numbers
  * @property {Uint8Array} [bytes]
  * @property {CustomType} [custom]
- * @property {Array<MessageType>} types
+ * @property {MessageType[]} types
  */
 
 /**

test/fixtures/embedded_type.js

@@ -41,7 +41,7 @@ export function writeEmbeddedType(obj, pbf) {
 
 /**
  * @typedef {object} EmbeddedTypeContainer
- * @property {Array<EmbeddedTypeContainerInner>} values
+ * @property {EmbeddedTypeContainerInner[]} values
  */
 
 /**

test/fixtures/map.js

@@ -37,7 +37,7 @@ export function writeEnvelope(obj, pbf) {
 }
 
 /**
- * @typedef {Object<string, string>} Envelope_FieldEntry1
+ * @typedef {Record<string, string>} Envelope_FieldEntry1
  */
 
 /**
@@ -69,7 +69,7 @@ export function writeEnvelope_FieldEntry1(obj, pbf) {
 }
 
 /**
- * @typedef {Object<string, number>} Envelope_FieldEntry2
+ * @typedef {Record<string, number>} Envelope_FieldEntry2
  */
 
 /**

test/fixtures/packed.js

@@ -4,8 +4,8 @@
 
 /**
  * @typedef {object} NotPacked
- * @property {Array<number>} value
- * @property {Array<number>} types
+ * @property {number[]} value
+ * @property {number[]} types
  */
 
 /**
@@ -38,8 +38,8 @@ export function writeNotPacked(obj, pbf) {
 
 /**
  * @typedef {object} FalsePacked
- * @property {Array<number>} value
- * @property {Array<number>} types
+ * @property {number[]} value
+ * @property {number[]} types
  */
 
 /**
@@ -72,8 +72,8 @@ export function writeFalsePacked(obj, pbf) {
 
 /**
  * @typedef {object} Packed
- * @property {Array<number>} value
- * @property {Array<number>} types
+ * @property {number[]} value
+ * @property {number[]} types
  */
 
 /**

test/fixtures/packed_proto3.js

@@ -10,8 +10,8 @@ export const MessageType = {
 
 /**
  * @typedef {object} NotPacked
- * @property {Array<number>} value
- * @property {Array<MessageType>} types
+ * @property {number[]} value
+ * @property {MessageType[]} types
  */
 
 /**
@@ -44,8 +44,8 @@ export function writeNotPacked(obj, pbf) {
 
 /**
  * @typedef {object} FalsePacked
- * @property {Array<number>} value
- * @property {Array<MessageType>} types
+ * @property {number[]} value
+ * @property {MessageType[]} types
  */
 
 /**
@@ -78,7 +78,7 @@ export function writeFalsePacked(obj, pbf) {
 
 /**
  * @typedef {object} Packed
- * @property {Array<number>} value
+ * @property {number[]} value
  */
 
 /**

test/fixtures/vector_tile.js

@@ -4,7 +4,7 @@
 
 /**
  * @typedef {object} Tile
- * @property {Array<TileLayer>} layers
+ * @property {TileLayer[]} layers
  */
 
 /**
@@ -93,9 +93,9 @@ export function writeTileValue(obj, pbf) {
 /**
  * @typedef {object} TileFeature
  * @property {number} [id]
- * @property {Array<number>} tags
+ * @property {number[]} tags
  * @property {TileGeomType} [type]
- * @property {Array<number>} geometry
+ * @property {number[]} geometry
  */
 
 /**
@@ -134,9 +134,9 @@ export function writeTileFeature(obj, pbf) {
  * @typedef {object} TileLayer
  * @property {number} version
  * @property {string} name
- * @property {Array<TileFeature>} features
- * @property {Array<string>} keys
- * @property {Array<TileValue>} values
+ * @property {TileFeature[]} features
+ * @property {string[]} keys
+ * @property {TileValue[]} values
  * @property {number} [extent]
  */