Typesense HTTP API にアクセスするための Javascript クライアント ライブラリ。
このライブラリはサーバー側とクライアント側の両方で使用できます。ライブラリのソースは ES6 にあり、ビルド時にそれを ES5 にトランスパイルし、サーバー側で使用できるアーティファクトと、Browserify を使用してクライアント側で使用できるアーティファクトの 2 つを生成します。
npm install --save typesense
ピアの依存関係をインストールします。
npm install --save @babel/runtime
注: @babel/runtime
、多くの JS ライブラリ間で非常に一般的な依存関係です。したがって、各ライブラリがそれを独立して依存関係として追加するのではなく(これにより、 @babel/runtime
の複数のインスタンスがインストールされ、バンドルサイズが増加します)、Babel の推奨事項は、ライブラリがユーザーにそれを直接の依存関係として 1 回インストールするように求めることです。プロジェクト全体に対して@babel/runtime
の 1 つのコピー。場合によっては、JS フレームワークに依存関係として@babel/runtime
が既に含まれている場合があります。
< script src =" dist/typesense.min.js " > </ script >
またはjsDelivr経由
< script src =" https://cdn.jsdelivr.net/npm/typesense@1/dist/typesense.min.js " > </ script >
詳細な例については、こちらのドキュメントをお読みください: https://typesense.org/docs/api/
テストは、ライブラリが内部でどのように動作するかを知るのに適した場所でもあります。
注: このライブラリをブラウザで使用する場合は、 master
API キーではなく、検索操作のみを許可する API キーを必ず使用してください。検索専用 API キーを生成する方法の例については、doc/examples/server/keys.js を参照してください。
すべてのクライアント構成オプションのリストについては、Configuration.ts を参照してください。
以下に、クライアントの使用方法を説明するインライン コメント付きの例をいくつか示します: doc/examples
例を実行するには、リポジトリのルートから次のようにします。
npm run typesenseServer
node doc/examples/server/bulkImport.js
フレームワークとして GatsbyJS を使用している場合、サイトの構築時にサイト データを自動的に Typesense にプッシュするプラグイン (舞台裏で typesense-js を使用する) が用意されています。詳細については、こちらをご覧ください。
Firebase を使用している場合は、Firestore データを Typesense に自動的にプッシュする Firebase 拡張機能 (バックグラウンドで typesense-js を使用します) が用意されています。詳細については、こちらをご覧ください。
強力なインスタント検索エクスペリエンスをすばやく構築するために使用できる UI コンポーネントについては、Typesense-InstantSearch.js (typesense-js を使用) を確認してください。
この表は、サーバー => クライアントの互換性を示しています。新しいバージョンのクライアント ライブラリは、古いバージョンのサーバー ライブラリとの下位互換性を維持します。
Typesenseサーバー | typesense-js |
---|---|
>= v27.0.rc20 | >= v2.0.0 |
>= v0.26.0.rc38 | >= v1.8.0 |
>= v0.25.0 | >= v1.7.0 |
>= v0.24.0 | >= v1.5.0 |
>= v0.23.0 | >= v1.3.0 |
>= v0.21.0 | >= v0.14.0 |
>= v0.20.0 | >= v0.12.0 |
>= v0.19.0 | >= v0.11.0 |
>= v0.18.0 | >= v0.10.0 |
>= v0.17.0 | >= v0.9.0 |
>= v0.16.0 | >= v0.8.0 |
>= v0.15.0 | >= v0.7.0 |
>= v0.12.1 | >= v0.5.0 |
>= v0.12.0 | >= v0.4.7 |
<= v0.11 | <= v0.3.0 |
リポジトリをチェックアウトした後、 npm install
実行して依存関係をインストールします。次に、 npm test
実行してリンターとテストを実行します。
新しいバージョンをリリースするには、np パッケージを使用します。
$ npm install --global np
$ np
# Follow instructions that np shows you
バグレポートとプルリクエストは、GitHub (https://github.com/typesense/typesense-js) で受け付けています。