chore: update documentation

Lint & format

Author: bevzzz

src/collections/config/index.ts

@@ -41,15 +41,15 @@ const config = <T>(
         .withClassName(name)
         .withProperty(resolveProperty<any>(property, []))
         .do()
-        .then(() => { }),
+        .then(() => {}),
     addReference: (
       reference: ReferenceSingleTargetConfigCreate<any> | ReferenceMultiTargetConfigCreate<any>
     ) =>
       new PropertyCreator(connection)
         .withClassName(name)
         .withProperty(resolveReference<any>(reference))
         .do()
-        .then(() => { }),
+        .then(() => {}),
     addVector: async (vectors: VectorizersConfigAdd<T>) => {
       const supportsDynamicVectorIndex = await dbVersionSupport.supportsDynamicVectorIndex();
       const { vectorsConfig } = makeVectorsConfig(vectors, supportsDynamicVectorIndex);
@@ -73,7 +73,7 @@ const config = <T>(
         })
       );
     },
-    updateShards: async function(status: 'READY' | 'READONLY', names?: string | string[]) {
+    updateShards: async function (status: 'READY' | 'READONLY', names?: string | string[]) {
       let shardNames: string[];
       if (names === undefined) {
         shardNames = await this.getShards().then((shards) => shards.map((s) => s.name));
@@ -98,7 +98,7 @@ const config = <T>(
           )
         )
         .then((merged) => new ClassUpdater(connection).withClass(merged).do())
-        .then(() => { });
+        .then(() => {});
     },
   };
 };

src/collections/config/integration.test.ts

@@ -12,7 +12,6 @@ import {
   VectorIndexConfigHNSW,
 } from './types/index.js';
 
-
 describe('Testing of the collection.config namespace', () => {
   let client: WeaviateClient;
 
@@ -555,8 +554,8 @@ describe('Testing of the collection.config namespace', () => {
       .update({
         propertyDescriptions: supportsUpdatingPropertyDescriptions
           ? {
-            testProp: 'This is a test property',
-          }
+              testProp: 'This is a test property',
+            }
           : undefined,
         vectorizers: weaviate.reconfigure.vectorizer.update({
           vectorIndexConfig: weaviate.reconfigure.vectorIndex.hnsw({

src/collections/config/types/vectorIndex.ts

@@ -65,7 +65,7 @@ export type RQConfig = {
   bits?: number;
   rescoreLimit?: number;
   type: 'rq';
-}
+};
 
 export type PQEncoderConfig = {
   type: PQEncoderType;

src/collections/config/utils.ts

@@ -213,11 +213,11 @@ export const makeVectorsConfig = <TProperties extends Properties | undefined = u
   const vectorizersConfig = Array.isArray(configVectorizers)
     ? configVectorizers
     : [
-      {
-        ...configVectorizers,
-        name: configVectorizers.name || 'default',
-      },
-    ];
+        {
+          ...configVectorizers,
+          name: configVectorizers.name || 'default',
+        },
+      ];
   vectorizersConfig.forEach((v) => {
     if (v.vectorIndex.name === 'dynamic' && !supportsDynamicVectorIndex.supports) {
       throw new WeaviateUnsupportedFeatureError(supportsDynamicVectorIndex.message);
@@ -340,18 +340,18 @@ class ConfigMapping {
         vectorizer:
           v.vectorizer === 'none'
             ? {
-              name: 'none',
-              config: undefined,
-            }
+                name: 'none',
+                config: undefined,
+              }
             : {
-              name: v.vectorizer,
-              config: v.moduleConfig
-                ? ({
-                  ...(v.moduleConfig[v.vectorizer] as any),
-                  vectorizeCollectionName: (v.moduleConfig[v.vectorizer] as any).vectorizeClassName,
-                } as VectorizerConfig)
-                : undefined,
-            },
+                name: v.vectorizer,
+                config: v.moduleConfig
+                  ? ({
+                      ...(v.moduleConfig[v.vectorizer] as any),
+                      vectorizeCollectionName: (v.moduleConfig[v.vectorizer] as any).vectorizeClassName,
+                    } as VectorizerConfig)
+                  : undefined,
+              },
         indexConfig: ConfigMapping.vectorIndex(v.vectorIndexConfig, v.vectorIndexType),
         indexType: ConfigMapping.vectorIndexType(v.vectorIndexType),
       },

src/collections/configure/types/vectorIndex.ts

@@ -23,7 +23,7 @@ export type RQConfigCreate = QuantizerRecursivePartial<RQConfig>;
 export type RQConfigUpdate = {
   rescoreLimit?: number;
   type: 'rq';
-}
+};
 
 export type PQConfigCreate = QuantizerRecursivePartial<PQConfig>;
 

src/collections/configure/vectorIndex.ts

@@ -65,9 +65,9 @@ const configure = {
       name: 'hnsw',
       config: rest
         ? {
-          ...rest,
-          distance: distanceMetric,
-        }
+            ...rest,
+            distance: distanceMetric,
+          }
         : undefined,
     };
   },
@@ -86,11 +86,11 @@ const configure = {
       name: 'dynamic',
       config: opts
         ? {
-          distance: opts.distanceMetric,
-          threshold: opts.threshold,
-          hnsw: isModuleConfig(opts.hnsw) ? opts.hnsw.config : configure.hnsw(opts.hnsw).config,
-          flat: isModuleConfig(opts.flat) ? opts.flat.config : configure.flat(opts.flat).config,
-        }
+            distance: opts.distanceMetric,
+            threshold: opts.threshold,
+            hnsw: isModuleConfig(opts.hnsw) ? opts.hnsw.config : configure.hnsw(opts.hnsw).config,
+            flat: isModuleConfig(opts.flat) ? opts.flat.config : configure.flat(opts.flat).config,
+          }
         : undefined,
     };
   },
@@ -115,7 +115,7 @@ const configure = {
     /**
      * Create an object of type `RQConfigCreate` to be used when defining the quantizer configuration of a vector index.
      *
-     * @param {number} [options.bits] TODO: WRITE DOCS
+     * @param {number} [options.bits] Number of bits to user per vector element.
      * @param {number} [options.rescoreLimit] The rescore limit. Default is 1000.
      * @returns {RQConfigCreate} The object of type `RQConfigCreate`.
      */
@@ -152,9 +152,9 @@ const configure = {
         centroids: options?.centroids,
         encoder: options?.encoder
           ? {
-            distribution: options.encoder.distribution,
-            type: options.encoder.type,
-          }
+              distribution: options.encoder.distribution,
+              type: options.encoder.type,
+            }
           : undefined,
         segments: options?.segments,
         trainingLimit: options?.trainingLimit,
@@ -254,7 +254,6 @@ const reconfigure = {
      * NOTE: If the vector index already has a quantizer configured, you cannot change its quantizer type; only its values.
      * So if you want to change the quantizer type, you must recreate the collection.
      *
-     * @param {number} [options.bits] TODO: WRITE DOCS
      * @param {number} [options.rescoreLimit] The new rescore limit.
      * @returns {BQConfigUpdate} The configuration object.
      */
@@ -290,9 +289,9 @@ const reconfigure = {
         encoder:
           pqEncoderDistribution || pqEncoderType
             ? {
-              distribution: pqEncoderDistribution,
-              type: pqEncoderType,
-            }
+                distribution: pqEncoderDistribution,
+                type: pqEncoderType,
+              }
             : undefined,
         type: 'pq',
       };

src/collections/index.ts

@@ -149,11 +149,11 @@ const collections = (connection: Connection, dbVersionSupport: DbVersionSupport)
         const configs = config.vectorizers
           ? makeLegacyVectorizer({ ...config.vectorizers, name: undefined })
           : {
-            vectorizer: undefined,
-            moduleConfig: undefined,
-            vectorIndexConfig: undefined,
-            vectorIndexType: undefined,
-          };
+              vectorizer: undefined,
+              moduleConfig: undefined,
+              vectorIndexConfig: undefined,
+              vectorIndexType: undefined,
+            };
         schema = {
           ...schema,
           moduleConfig: {
@@ -177,7 +177,7 @@ const collections = (connection: Connection, dbVersionSupport: DbVersionSupport)
       await new ClassCreator(connection).withClass(schema).do();
       return collection<TProperties, TName>(connection, name, dbVersionSupport);
     },
-    createFromSchema: async function(config: WeaviateClass) {
+    createFromSchema: async function (config: WeaviateClass) {
       const { class: name } = await new ClassCreator(connection).withClass(config).do();
       return collection<Properties, string>(connection, name as string, dbVersionSupport);
     },