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
لتشغيل الأمثلة، من جذر الريبو:
npm run typesenseServer
node doc/examples/server/bulkImport.jsإذا كنت تستخدم GatsbyJS لإطار عمل، فلدينا مكون إضافي (يستخدم typeense-js خلف الكواليس) لدفع بيانات موقعك تلقائيًا إلى Typesense عند إنشاء موقعك. تعلم المزيد هنا.
إذا كنت تستخدم Firebase، فلدينا امتداد Firebase (يستخدم typeense-js خلف الكواليس) لدفع بيانات Firestore تلقائيًا إلى Typesense. تعلم المزيد هنا.
قم بمراجعة Typesense-InstantSearch.js (الذي يستخدم typesense-js) للتعرف على مكونات واجهة المستخدم التي يمكنك استخدامها لبناء تجارب بحث فورية قوية بسرعة.
يشير هذا الجدول إلى توافق الخادم=>العميل. تحافظ الإصدارات الأحدث من مكتبة العميل على التوافق مع الإصدارات الأقدم من مكتبة الخادم.
| خادم تايب سينس | typeense-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.
