Improved types [skip ci]

Author: ankane

src/sparse-vector.js

@@ -10,22 +10,36 @@ export class SparseVector {
   /** @type {number[]} */
   values = [];
 
+  /**
+   * @overload
+   * @param {string | number[]} value
+   *
+   * @overload
+   * @param {Map<number, number>} value
+   * @param {number} dimensions
+   */
   constructor(value, dimensions) {
-    if (typeof value === 'string') {
-      this.#fromSql(value);
-    } else if (dimensions !== undefined) {
+    if (dimensions !== undefined) {
       this.#fromMap(value, dimensions);
+    } else if (typeof value === 'string') {
+      this.#fromSql(value);
     } else {
       this.#fromDense(value);
     }
   }
 
+  /**
+   * @returns {string}
+   */
   toPostgres() {
     const values = this.values;
     const elements = this.indices.map((index, i) => format('%i:%f', index + 1, values[i])).join(',');
     return format('{%s}/%d', elements, this.dimensions);
   }
 
+  /**
+   * @returns {string}
+   */
   toString() {
     return this.toPostgres();
   }
@@ -41,6 +55,9 @@ export class SparseVector {
     return arr;
   }
 
+  /**
+   * @param {string} value
+   */
   #fromSql(value) {
     const parts = value.split('/', 2);
 
@@ -54,6 +71,9 @@ export class SparseVector {
     }
   }
 
+  /**
+   * @param {number[]} value
+   */
   #fromDense(value) {
     this.dimensions = value.length;
 
@@ -66,6 +86,10 @@ export class SparseVector {
     }
   }
 
+  /**
+   * @param {Map<number, number>} map
+   * @param {number} dimensions
+   */
   #fromMap(map, dimensions) {
     this.dimensions = Number(dimensions);
 

src/utils.js

@@ -18,6 +18,9 @@ export function vectorToSql(value) {
 export { vectorFromSql as halfvecFromSql };
 export { vectorToSql as halfvecToSql };
 
+/**
+ * @returns {?SparseVector}
+ */
 export function sparsevecFromSql(value) {
   if (value === null) {
     return null;
@@ -32,6 +35,11 @@ export function sparsevecToSql(value) {
   return value;
 }
 
+/**
+ * @param {string} name
+ * @param {number | null | undefined} dimensions
+ * @returns {string}
+ */
 function typeWithDimensions(name, dimensions) {
   if (dimensions === undefined || dimensions === null) {
     return name;
@@ -44,18 +52,34 @@ function typeWithDimensions(name, dimensions) {
   return format('%s(%d)', name, dimensions);
 }
 
+/**
+ * @param {number | null | undefined} dimensions
+ * @returns {string}
+ */
 export function vectorType(dimensions) {
   return typeWithDimensions('vector', dimensions);
 }
 
+/**
+ * @param {number | null | undefined} dimensions
+ * @returns {string}
+ */
 export function halfvecType(dimensions) {
   return typeWithDimensions('halfvec', dimensions);
 }
 
+/**
+ * @param {number | null | undefined} dimensions
+ * @returns {string}
+ */
 export function bitType(dimensions) {
   return typeWithDimensions('bit', dimensions);
 }
 
+/**
+ * @param {number | null | undefined} dimensions
+ * @returns {string}
+ */
 export function sparsevecType(dimensions) {
   return typeWithDimensions('sparsevec', dimensions);
 }

types/mikro-orm/bit.d.ts

@@ -1,5 +1,5 @@
 export class BitType extends Type<string, string> {
     constructor();
-    getColumnType(prop: any, platform: any): any;
+    getColumnType(prop: any, platform: any): string;
 }
 import { Type } from '@mikro-orm/core';

types/mikro-orm/halfvec.d.ts

@@ -2,6 +2,6 @@ export class HalfvecType extends Type<string, string> {
     constructor();
     convertToDatabaseValue(value: any, platform: any): any;
     convertToJSValue(value: any, platform: any): any;
-    getColumnType(prop: any, platform: any): any;
+    getColumnType(prop: any, platform: any): string;
 }
 import { Type } from '@mikro-orm/core';

types/mikro-orm/sparsevec.d.ts

@@ -2,6 +2,6 @@ export class SparsevecType extends Type<string, string> {
     constructor();
     convertToDatabaseValue(value: any, platform: any): any;
     convertToJSValue(value: any, platform: any): import("../sparse-vector.js").SparseVector | null;
-    getColumnType(prop: any, platform: any): any;
+    getColumnType(prop: any, platform: any): string;
 }
 import { Type } from '@mikro-orm/core';

types/mikro-orm/vector.d.ts

@@ -2,6 +2,6 @@ export class VectorType extends Type<string, string> {
     constructor();
     convertToDatabaseValue(value: any, platform: any): any;
     convertToJSValue(value: any, platform: any): any;
-    getColumnType(prop: any, platform: any): any;
+    getColumnType(prop: any, platform: any): string;
 }
 import { Type } from '@mikro-orm/core';

types/sparse-vector.d.ts

@@ -1,5 +1,6 @@
 export class SparseVector {
-    constructor(value: any, dimensions: any);
+    constructor(value: string | number[]);
+    constructor(value: Map<number, number>, dimensions: number);
     dimensions: number;
     indices: number[];
     values: number[];

types/utils.d.ts

@@ -2,9 +2,9 @@ export function vectorFromSql(value: any): any;
 export function vectorToSql(value: any): any;
 export function sparsevecFromSql(value: any): SparseVector | null;
 export function sparsevecToSql(value: any): any;
-export function vectorType(dimensions: any): any;
-export function halfvecType(dimensions: any): any;
-export function bitType(dimensions: any): any;
-export function sparsevecType(dimensions: any): any;
+export function vectorType(dimensions: number | null | undefined): string;
+export function halfvecType(dimensions: number | null | undefined): string;
+export function bitType(dimensions: number | null | undefined): string;
+export function sparsevecType(dimensions: number | null | undefined): string;
 import { SparseVector } from './sparse-vector.js';
 export { vectorFromSql as halfvecFromSql, vectorToSql as halfvecToSql };