Meilisearch JS
    Preparing search index...

    Type Alias Config

    Main configuration object for the meilisearch client.

    type Config = {
        apiKey?: string;
        clientAgents?: string[];
        defaultWaitOptions?: WaitOptions;
        host: string;
        httpClient?: (...args: Parameters<typeof fetch>) => Promise<unknown>;
        requestInit?: BaseRequestInit;
        timeout?: number;
    }
    Index

    Properties

    apiKey? clientAgents? defaultWaitOptions? host httpClient? requestInit? timeout?

    Properties

    apiKey?: string

    API key for interacting with a meilisearch instance.

    https://www.meilisearch.com/docs/learn/security/basic_security

    clientAgents?: string[]

    Custom strings that will be concatted to the "X-Meilisearch-Client" header on each request.

    defaultWaitOptions?: WaitOptions

    Customizable default options for awaiting tasks.

    host: string

    The base URL for reaching a meilisearch instance.

    Protocol and trailing slash can be omitted.

    httpClient?: (...args: Parameters<typeof fetch>) => Promise<unknown>

    Custom function that can be provided in place of fetch.

    API response errors will have to be handled manually with this as well.

    This will be removed in a future version. See issue.

    requestInit?: BaseRequestInit

    Base request options that may override the default ones.

    timeout?: number

    Timeout in milliseconds for each HTTP request.

    Settings

    Member Visibility

    On This Page

    Properties