typesense js
v1.8.2
用於存取 Typesense HTTP API 的 Javascript 用戶端程式庫。
該庫既可以在伺服器端也可以在客戶端使用。該庫的源代碼位於 ES6 中，在建置期間，我們將其轉換為 ES5 並產生兩個工件 - 一個可以在伺服器端使用，另一個使用 Browserify 並可以在客戶端使用。
npm install --save typesense安裝對等依賴項：
npm install --save @babel/runtime注意： @babel/runtime是許多 JS 庫中非常常見的依賴項。因此，Babel 的建議是，程式庫要求使用者將其作為直接依賴項安裝一次，而不是每個庫獨立地將其添加為依賴項（這將導致安裝@babel/runtime的多個實例，從而增加套件大小@babel/runtime 。在某些情況下，您的 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/
測試也是了解庫內部如何運作的好地方：test
注意：在瀏覽器中使用此程式庫時，請務必使用僅允許搜尋操作的 API Key，而不是master API Key。有關如何產生僅搜尋 API 金鑰的範例，請參閱 doc/examples/server/keys.js。
有關所有客戶端設定選項的列表，請參閱 Configuration.ts。
以下是一些帶有內聯註解的範例，可引導您了解如何使用客戶端：doc/examples
若要從儲存庫根目錄執行範例：
npm run typesenseServer
node doc/examples/server/bulkImport.js如果您使用 GatsbyJS 作為框架，我們有一個外掛程式（在幕後使用 typesense-js），可以在您建立網站時自動將網站資料推送到 Typesense。在這裡了解更多。
如果您使用 Firebase，我們有一個 Firebase 擴充功能（在背景使用 typesense-js）來自動將您的 Firestore 資料推送到 Typesense。在這裡了解更多。
查看 Typesense-InstantSearch.js（它使用 typesense-js）來取得可用於快速建立強大的即時搜尋體驗的 UI 元件。
該表指的是伺服器=>客戶端相容性。新版本的客戶端庫保持與舊版本的伺服器庫的向後相容性。
| 類型感應伺服器 | 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來執行 linter 和測試。
要發布新版本，我們使用 np 套件：
$ npm install --global np
$ np
# Follow instructions that np shows you
歡迎在 GitHub 提交錯誤報告和拉取要求：https://github.com/typesense/typesense-js。
