@interopio/search-api

Overview

The @interopio/search-api library enables you to create both search providers and search clients in io.Connect Desktop and io.Connect Browser projects.

Installation

To install the library, execute the following command:

npm install @interopio/search-api

Usage

The following examples demonstrate basic initialization of the @interopio/search-api library in io.Connect Desktop and io.Connect Browser projects.

ℹ️ For more details on using the @interopio/search-api library in io.Connect Desktop projects, see the io.Connect Desktop official documentation.

ℹ️ For more details on using the @interopio/search-api library in io.Connect Browser projects, see the io.Connect Browser official documentation.

io.Connect Desktop

Initializing the @interopio/search-api library in a client app of an io.Connect Desktop project:

import IODesktop from "@interopio/desktop";
import IOSearch from "@interopio/search-api";

const config = {
    libraries: [IOSearch]
};

const io = await IODesktop(config);

// Now you can access the Search API via `io.search`.

io.Connect Browser

Initializing the @interopio/search-api library in the Main app of an io.Connect Browser project:

import IOBrowserPlatform from "@interopio/browser-platform";
import IOSearch from "@interopio/search-api";

const config = {
    licenseKey: "my-license-key",
    browser: {
        libraries: [IOSearch]
    }
};

const { io } = await IOBrowserPlatform(config);

// Now you can access the Search API via `io.search`.

Initializing the @interopio/search-api library in a Browser Client app of an io.Connect Browser project:

import IOBrowser from "@interopio/browser";
import IOSearch from "@interopio/search-api";

const config = {
    libraries: [IOSearch]
};

const io = await IOBrowser(config);

// Now you can access the Search API via `io.search`.