@lableb/javascript-sdk
Version:
Lableb cloud search client for javascript
34 lines (33 loc) • 1.43 kB
TypeScript
import { LablebSDKtInterceptor } from "../../core/lableb-client/lableb-client.type";
import { BuildRequestResult, OptionalBaseRequestParams } from "../../types";
import { LablebRequestBuilder } from "./main.request";
export interface InterceptorParams extends BuildRequestResult {
body?: any;
}
export interface GlobalRequestOptions extends OptionalBaseRequestParams {
/**
* global API Key copied from [Lableb Dashboard](https://dashboard.lableb.com)
*
* When creating a new API key, make sure you check "search" permission in order to make this key
* usable for search, autocomplete and recommend requests
*/
APIKey?: string;
/**
* global indexing API Key copied from [Lableb Dashboard](https://dashboard.lableb.com)
*
* When creating a new Indexing API Key, make sure you check "index" permission in order to make this key
* usable in indexing, delete requests
*/
indexingAPIKey?: string;
/** global platform name in small-letters */
platformName?: string;
/** global index name used for search, autocomplete, and recommend requests */
indexName?: string;
searchHandler?: string;
autocompleteHandler?: string;
recommendHandler?: string;
}
export interface OverloadedGlobalOptions {
interceptors?: LablebSDKtInterceptor<any, any>[];
}
export declare type LablebRequestBuilderType = ReturnType<typeof LablebRequestBuilder>;