@devbookhq/extension

Devbook Extension

Devbook extensions allow users to add search sources that aren’t supported out-of-the-box by Devbook. It’s like a programmable search engine.

Your extension doesn’t have to implement the search logic or any user interface. You only have to do two things:

1. Upload the search data into Devbook's search engine and keep them up-to-date.
2. React to user events in the Devbook app.

For uploading extension's search data into Devbook's search engine, use Devbook Extension Admin API.

Installation

npm install @devbookhq/extension
or
yarn add @devbookhq/extension

Usage

import Devbook from '@devbookhq/extension';

const extensionEventHandlers: Devbook.ExtensionEventHandlers = {
  // Called every time user changes the search query in the Devbook search input.
  onDidQueryChange: async (data, extensionMode, token) => {
    // Mock example not fetching any data from the extension data.
    const results = [
      {
        id: '1',
        result: {
          title: 'Hello World!',
          body: `The search query was ${data.query}`,
        },
      },
    ];
    return { results };

    // You can fetch your extension data from https://api.usedevbook.com/v1/extension/:yourExtensionID/entry/query.
    // You can use our exported predefined functions for that:

    // const results = await Devbook.search(data.query, {
    //   indexes: ['testIndex'],
    // });
    // return { results };
  },
}

export default extensionEventHandlers;

Documentation

TODO: Add a link to documentation.

Read the extension guide.

Examples

Check out the extension examples.