Misc

Author: flevi29

src/types/network.ts

@@ -1,7 +1,7 @@
 /**
  * {@link https://www.meilisearch.com/docs/reference/api/network#the-remote-object}
  *
- * @see `meilisearch_types::features::Remote` at {@link https://github.com/meilisearch/meilisearch}
+ * @see `meilisearch_types::features::Remote`
  */
 export type Remote = {
   url: string;
@@ -11,7 +11,7 @@ export type Remote = {
 /**
  * {@link https://www.meilisearch.com/docs/reference/api/network#the-network-object}
  *
- * @see `meilisearch_types::features::Network` at {@link https://github.com/meilisearch/meilisearch}
+ * @see `meilisearch_types::features::Network`
  */
 export type Network = {
   self: string | null;

src/types/token.ts

@@ -8,7 +8,7 @@ export type TokenIndexRules = Pick<SearchQuery, "filter">;
  *
  * @remarks
  * Not well documented.
- * @see `meilisearch_auth::SearchRules` at {@link https://github.com/meilisearch/meilisearch}
+ * @see `meilisearch_auth::SearchRules`
  */
 export type TokenSearchRules =
   | Record<string, TokenIndexRules | null>

src/types/types.ts

@@ -67,7 +67,6 @@ export type Config = {
   httpClient?: (...args: Parameters<typeof fetch>) => Promise<unknown>;
   /** Timeout in milliseconds for each HTTP request. */
   timeout?: number;
-  /** Options for waiting on tasks. */
   defaultWaitOptions?: WaitOptions;
 };
 

tests/search.test.ts

@@ -3,7 +3,7 @@ import {
   assert,
   HOST,
   MASTER_KEY,
-  ObjectKeys,
+  objectKeys,
 } from "./utils/meilisearch-test-utils.js";
 import { type Film, FILMS } from "./utils/test-data/films.js";
 import type {
@@ -31,7 +31,6 @@ import {
 } from "./utils/search.js";
 
 beforeAll(async () => {
-  // TODO: If this disables the rest of the experimental features, that might be a problem, consider https://vitest.dev/config/#globalsetup
   await client.updateExperimentalFeatures({ network: true });
   await client.updateNetwork({
     self: INDEX_UID,
@@ -56,28 +55,20 @@ beforeAll(async () => {
       },
     })
     .waitTask()
-    .then(({ status, error }) => {
-      assert.isNull(error);
-      assert.strictEqual(status, "succeeded");
+    .then((task) => {
+      assert.isTaskSuccessful(task);
     });
 
   await index
     .addDocuments(FILMS)
     .waitTask()
-    .then(({ status, error }) => {
-      assert.isNull(error);
-      assert.strictEqual(status, "succeeded");
+    .then((task) => {
+      assert.isTaskSuccessful(task);
     });
 });
 
 afterAll(async () => {
-  await index
-    .delete()
-    .waitTask()
-    .then(({ status, error }) => {
-      assert.isNull(error);
-      assert.strictEqual(status, "succeeded");
-    });
+  await index.delete().waitTask();
   await client.updateNetwork({});
 });
 
@@ -296,7 +287,7 @@ describe.concurrent("`showMatchesPosition` param", () => {
   );
 });
 
-const possibleMatchingStrategies = ObjectKeys<MatchingStrategy>({
+const possibleMatchingStrategies = objectKeys<MatchingStrategy>({
   last: null,
   all: null,
   frequency: null,
@@ -324,7 +315,6 @@ describe.concurrent.for(possibleMatchingStrategies)(
   },
 );
 
-// TODO: Another filter with geo filtering
 const filterExpressions: [name: string, filter: FilterExpression][] = [
   ["string", `release_date < ${Date.parse("1998-01-01")} AND id = 607`],
   ["array", [[`release_date < ${Date.parse("1998-01-01")}`], ["id = 607"]]],

tests/utils/meilisearch-test-utils.ts

@@ -256,12 +256,12 @@ export type Book = {
   author: string;
 };
 
-function ObjectKeys<T extends string>(o: { [TKey in T]: null }): T[] {
+function objectKeys<T extends string>(o: { [TKey in T]: null }): T[] {
   return Object.keys(o) as T[];
 }
 
 export {
-  ObjectKeys,
+  objectKeys,
   clearAllIndexes,
   config,
   masterClient,