@lableb/javascript-sdk/src/types/base.type.ts

Lableb cloud search client for javascript

import { ALLOWED_HTTP_METHOD } from "../http-client/client.type";

export interface OptionalBaseRequestParams {

    /** uniques session Id for your end user */
    sessionId?: string,

    /** end user id */
    userId?: string,

    /** end user IP address */
    userIp?: string,

    /** end user country code(ISO-3166) */
    userCountry?: string,

    /** pass callback that generate unique session id sting*/
    sessionIdGenerator?: () => string,
}


export interface BaseRequestParams extends OptionalBaseRequestParams {

    /** your platform name in small-letters */
    platformName?: string,

    /** the used index name for the autocomplete function */
    indexName?: string,

    /** your autocomplete API Key copied from [Lableb Dashboard](https://dashboard.lableb.com) */
    APIKey?: string,
}


export interface BuildRequestResult {
    url: string,
    params: any,
    headers: any,
    method: ALLOWED_HTTP_METHOD
}