How to load/import/include FlexSearch into common environments

[ts-thomas]

Please let us collect all the environments which needs to be supported out of the box and what is needed to reach this goal. It should have the most simple solution for the specific environment. So please feel free to make your suggestions and don't forget to provide a full example of what is needed to do.

Browser

Legacy ES5 Script Tags

<script src="node_modules/flexsearch/dist/flexsearch.bundle.min.js"></script>
<script>

    // FlexSearch is available on window.FlexSearch
    // Access FlexSearch static methods via bundled export (static class methods of FlexSearch)

    const index = FlexSearch.Index(options);
    const document = FlexSearch.Document(options);
    const worker = FlexSearch.Worker(options);

</script>

ES6 Modules (ESM)

<script type="module">

    // FlexSearch is NOT available on window.FlexSearch
    // Access FlexSearch static methods by importing them explicitely

    import Index from "./node_modules/flexsearch/dist/module/index";
    import Document from "./node_modules/flexsearch/dist/module/document";
    import Worker from "./node_modules/flexsearch/dist/module/worker";

    const index = new Index(options);
    const document = new Document(options);
    const worker = new WorkerIndex(options);

</script>

ES6 Bundled Module (ESM)

<script type="module">

    // FlexSearch is NOT available on window.FlexSearch
    // Access FlexSearch static methods via bundled export (static class methods of FlexSearch)

    import FlexSearch from "./node_modules/flexsearch/dist/flexsearch.bundle.module.min.js";

    const index = FlexSearch.Index(options);
    const document = FlexSearch.Document(options);
    const worker = FlexSearch.Worker(options);

</script>

Node.js

Default Require

const FlexSearch = require("flexsearch");

const index = new FlexSearch.Index(options);
const document = new FlexSearch.Document(options);
const worker = new FlexSearch.Worker(options);

Or:

const { Index, Document, Worker } = require("flexsearch");

const index = new Index(options);
const document = new Document(options);
const worker = new Worker(options);

[thexeos]

Using Vite and with tsconfig set to moduleResolution = bundler, I had success with:

// @ts-expect-error there are no types expected here
import { Index, Document, Worker } from 'flexsearch/dist/flexsearch.bundle'

It's not ideal, but it means require() can be avoided to appease the linter and bundler.

[ts-thomas]

Have you tried from 'flexsearch/dist/flexsearch.bundle.module.min'? It's included in the latest build. It would be nice if you was able to remove the @ts-expect-error flag.

[ts-thomas]

You can give from 'flexsearch' a chance also

[thexeos]

You are absolutely right. With latest release it is possible to do:

import FlexSearch from 'flexsearch'

However doing

import { Document } from 'flexsearch'

will result in error:

due to how the generated file only provides default export and none of the named ones:

So the latest version of my code now uses:

import FlexSearch from 'flexsearch'

new FlexSearch.Document()