typesense js
v1.8.2
ไลบรารีไคลเอ็นต์ Javascript สำหรับการเข้าถึง Typesense HTTP API
ไลบรารีนี้สามารถใช้ได้ทั้งบนฝั่งเซิร์ฟเวอร์และฝั่งไคลเอ็นต์ แหล่งที่มาของไลบรารีอยู่ใน ES6 และในระหว่างเวลาสร้าง เราจะแปลงเป็น ES5 และสร้างอาร์ติแฟกต์สองรายการ - อันหนึ่งสามารถใช้บนฝั่งเซิร์ฟเวอร์และอีกอันใช้ Browserify และสามารถใช้ได้บนฝั่งไคลเอ็นต์
npm install --save typesenseติดตั้งการพึ่งพาเพียร์:
npm install --save @babel/runtime หมายเหตุ: @babel/runtime เป็นการพึ่งพากันทั่วไปในไลบรารี JS หลายแห่ง ดังนั้นแทนที่จะให้แต่ละไลบรารีเพิ่มเป็นการพึ่งพาอย่างอิสระ (ซึ่งจะทำให้ @babel/runtime หลายอินสแตนซ์ถูกติดตั้งเพิ่มขนาดบันเดิล) คำแนะนำของ Babel ก็คือไลบรารีขอให้ผู้ใช้ติดตั้งเพียงครั้งเดียวเป็นการพึ่งพาโดยตรง ดังนั้นจึงมีเพียง หนึ่งสำเนาของ @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/
การทดสอบยังเป็นสถานที่ที่ดีในการทราบว่าห้องสมุดทำงานอย่างไรภายใน: การทดสอบ
หมายเหตุ: เมื่อใช้ไลบรารีนี้ในเบราว์เซอร์ โปรดแน่ใจว่าใช้คีย์ API ที่อนุญาตเฉพาะการดำเนินการค้นหาแทนคีย์ API master ดู doc/examples/server/keys.js สำหรับตัวอย่างวิธีสร้างคีย์ API สำหรับการค้นหาเท่านั้น
ดู Configuration.ts สำหรับรายการตัวเลือกการกำหนดค่าไคลเอนต์ทั้งหมด
ต่อไปนี้เป็นตัวอย่างบางส่วนพร้อมความคิดเห็นแบบอินไลน์ที่จะแนะนำวิธีใช้ไคลเอ็นต์: doc/examples
หากต้องการรันตัวอย่างจากรูท repo:
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 | >= เวอร์ชัน 2.0.0 |
| >= v0.26.0.rc38 | >= เวอร์ชัน 1.8.0 |
| >= v0.25.0 | >= เวอร์ชัน 1.7.0 |
| >= v0.24.0 | >= เวอร์ชัน 1.5.0 |
| >= v0.23.0 | >= เวอร์ชัน 1.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 |
หลังจากตรวจสอบ repo แล้ว ให้รัน npm install เพื่อติดตั้งการขึ้นต่อกัน จากนั้นรัน npm test เพื่อรัน linter และการทดสอบ
เพื่อออกเวอร์ชันใหม่ เราใช้แพ็คเกจ np:
$ npm install --global np
$ np
# Follow instructions that np shows you
รายงานข้อผิดพลาดและคำขอดึงข้อมูลยินดีต้อนรับบน GitHub ที่ https://github.com/typesense/typesense-js
