[Search] Fix the Linter Errors

sdk/search/search-documents/review/search-documents.api.md

@@ -387,7 +387,7 @@ export class GeographyPoint {
     constructor(latitude: number, longitude: number);
     latitude: number;
     longitude: number;
-    toJSON(): object;
+    toJSON(): Record<string, unknown>;
 }
 
 // @public
@@ -541,10 +541,10 @@ export interface IndexingSchedule {
 }
 
 // @public
-export type IndexIterator = PagedAsyncIterableIterator<SearchIndex, SearchIndex[], {}>;
+export type IndexIterator = PagedAsyncIterableIterator<SearchIndex, SearchIndex[], Record<string, unknown>>;
 
 // @public
-export type IndexNameIterator = PagedAsyncIterableIterator<string, string[], {}>;
+export type IndexNameIterator = PagedAsyncIterableIterator<string, string[], Record<string, unknown>>;
 
 // @public
 export interface InputFieldMappingEntry {
@@ -1028,19 +1028,17 @@ export interface ScoringProfile {
 // @public
 export type ScoringStatistics = 'local' | 'global';
 
-// @public
-export class SearchClient<T> {
-    constructor(endpoint: string, indexName: string, credential: KeyCredential, options?: SearchClientOptions);
-    readonly apiVersion: string;
+// @public (undocumented)
+export interface SearchClient<T> {
     autocomplete<Fields extends keyof T>(searchText: string, suggesterName: string, options?: AutocompleteOptions<Fields>): Promise<AutocompleteResult>;
     deleteDocuments(documents: T[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
     deleteDocuments(keyName: keyof T, keyValues: string[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
-    readonly endpoint: string;
+    // (undocumented)
+    deleteDocuments(keyNameOrDocuments: keyof T | T[], keyValuesOrOptions?: string[] | DeleteDocumentsOptions, options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
     getDocument<Fields extends keyof T>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
     getDocumentsCount(options?: CountDocumentsOptions): Promise<number>;
     getSearchIndexingBufferedSenderInstance(options?: SearchIndexingBufferedSenderOptions): SearchIndexingBufferedSender<T>;
     indexDocuments(batch: IndexDocumentsBatch<T>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>;
-    readonly indexName: string;
     mergeDocuments(documents: T[], options?: MergeDocumentsOptions): Promise<IndexDocumentsResult>;
     mergeOrUploadDocuments(documents: T[], options?: MergeOrUploadDocumentsOptions): Promise<IndexDocumentsResult>;
     search<Fields extends keyof T>(searchText?: string, options?: SearchOptions<Fields>): Promise<SearchDocumentsResult<Pick<T, Fields>>>;

sdk/search/search-documents/src/base64.browser.ts

@@ -3,15 +3,15 @@
 
 /**
  * Encodes a string in base64 format.
- * @param value The string to encode.
+ * @param value - The string to encode.
  */
 export function encode(value: string): string {
   return btoa(value);
 }
 
 /**
  * Decodes a base64 string into a regular string.
- * @param value The base64 string to decode.
+ * @param value - The base64 string to decode.
  */
 export function decode(value: string): string {
   return atob(value);

sdk/search/search-documents/src/base64.ts

@@ -3,15 +3,15 @@
 
 /**
  * Encodes a string in base64 format.
- * @param value The string to encode.
+ * @param value - The string to encode.
  */
 export function encode(value: string): string {
   return Buffer.from(value).toString("base64");
 }
 
 /**
  * Decodes a base64 string into a regular string.
- * @param value The base64 string to decode.
+ * @param value - The base64 string to decode.
  */
 export function decode(value: string): string {
   return Buffer.from(value, "base64").toString();

sdk/search/search-documents/src/geographyPoint.ts

@@ -19,8 +19,8 @@ export default class GeographyPoint {
   /**
    * Constructs a new instance of GeographyPoint given
    * the specified coordinates.
-   * @param latitude latitude value in decimal
-   * @param longitude longitude value in decimal
+   * @param latitude - latitude value in decimal
+   * @param longitude - longitude value in decimal
    */
   constructor(latitude: number, longitude: number) {
     this.latitude = latitude;
@@ -30,7 +30,7 @@ export default class GeographyPoint {
   /**
    * Used to serialize to a GeoJSON Point.
    */
-  public toJSON(): object {
+  public toJSON(): Record<string, unknown> {
     return {
       type: "Point",
       coordinates: [this.longitude, this.latitude],

sdk/search/search-documents/src/index.ts

@@ -1,7 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export { SearchClient, SearchClientOptions } from "./searchClient";
+export { SearchClientOptions } from "./searchClientImpl";
+export { SearchClient } from "./searchClient";
 export {
   DEFAULT_BATCH_SIZE,
   DEFAULT_FLUSH_WINDOW,

sdk/search/search-documents/src/indexDocumentsBatch.ts

@@ -19,7 +19,7 @@ export class IndexDocumentsBatch<T> {
 
   /**
    * Upload an array of documents to the index.
-   * @param documents The documents to upload.
+   * @param documents - The documents to upload.
    */
   public upload(documents: T[]): void {
     const batch = documents.map<IndexDocumentsAction<T>>((doc) => {
@@ -35,7 +35,7 @@ export class IndexDocumentsBatch<T> {
   /**
    * Update a set of documents in the index.
    * For more details about how merging works, see https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
-   * @param documents The updated documents.
+   * @param documents - The updated documents.
    */
   public merge(documents: T[]): void {
     const batch = documents.map<IndexDocumentsAction<T>>((doc) => {
@@ -51,7 +51,7 @@ export class IndexDocumentsBatch<T> {
   /**
    * Update a set of documents in the index or uploads them if they don't exist.
    * For more details about how merging works, see https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
-   * @param documents The new/updated documents.
+   * @param documents - The new/updated documents.
    */
   public mergeOrUpload(documents: T[]): void {
     const batch = documents.map<IndexDocumentsAction<T>>((doc) => {
@@ -66,14 +66,14 @@ export class IndexDocumentsBatch<T> {
 
   /**
    * Delete a set of documents.
-   * @param keyName The name of their primary key in the index.
-   * @param keyValues The primary key values of documents to delete.
+   * @param keyName - The name of their primary key in the index.
+   * @param keyValues - The primary key values of documents to delete.
    */
   public delete(keyName: keyof T, keyValues: string[]): void;
 
   /**
    * Delete a set of documents.
-   * @param documents Documents to be deleted.
+   * @param documents - Documents to be deleted.
    */
   public delete(documents: T[]): void;
 

sdk/search/search-documents/src/logger.ts

@@ -4,6 +4,6 @@
 import { createClientLogger } from "@azure/logger";
 
 /**
- * The @azure/logger configuration for this package.
+ * The \@azure/logger configuration for this package.
  */
 export const logger = createClientLogger("search");

sdk/search/search-documents/src/odata.ts

@@ -32,8 +32,8 @@ function escapeQuotesIfString(input: unknown, previous: string): string | unknow
  * const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;
  * ```
  * For more information on supported syntax see: https://docs.microsoft.com/en-us/azure/search/search-query-odata-filter
- * @param strings
- * @param values
+ * @param strings - Array of strings for the expression
+ * @param values - Array of values for the expression
  */
 export function odata(strings: TemplateStringsArray, ...values: unknown[]): string {
   const results = [];