NativeScript-Algolia

NativeScript 插件，用于 Algolia 搜索。

此插件旨在尽可能模仿 Algolia 的 JavaScript 客户端结构。对于现有应用程序，无需更改或添加任何额外逻辑，它将在 NativeScript 中运行。

许可证

此插件由 Arpit Srivastava 以 MIT 许可证发布

安装

要安装，请输入

tns plugin add nativescript-algolia

目录

1. 安装

   • NativeScript

2. 快速入门

   • 初始化客户端
   • 推送数据
   • 搜索
   • 配置

入门指南

安装

NativeScript

tns plugin add nativescript-algolia

快速入门

在 30 秒内，本快速入门教程将向您展示如何索引和搜索对象。

初始化客户端

首先，您需要初始化客户端。为此，您需要您的 应用程序 ID 和 API 密钥。您可以在您的 Algolia 账户 上找到这两个密钥。

import {Algolia} from "nativescript-algolia";
var client = new Algolia('applicationID', 'apiKey');
var index = client.initIndex('contacts');

推送数据

在不进行任何先前配置的情况下，您可以使用以下代码在 contacts 索引中开始索引 500 个联系人。

var index = client.initIndex('contacts');
var contactsJSON = require('./contacts.json');

index.addObjects(contactsJSON, function(content, err) {
  if (err) {
    console.error(err);
  }
});

搜索

完成这些任务后，您现在可以通过查询诸如姓名、姓氏、公司等字段来搜索联系人。由于 Algolia 具有拼写容忍度，因此可以轻松处理常见的拼写错误。

// firstname
index.search('jimmie', function(content, err) {
  console.log(content.hits);
});

// firstname with typo
index.search('jimie', function(content, err) {
  console.log(content.hits);
});

// a company
index.search('california paint', function(content, err) {
  console.log(content.hits);
});

// a firstname & company
index.search('jimmie paint', function(content, err) {
  console.log(content.hits);
});

配置

可以自定义设置以调整搜索行为。例如，您可以将按关注者数量排序的定制排序添加到内置的相关性中。

index.setSettings({
  'customRanking': ['desc(followers)']
}, function(err, content) {
  console.log(content);
});

您还可以按重要性顺序配置要索引的属性列表（例如：姓名 = 最重要）

注意：由于该引擎旨在在您输入时提供建议，您通常通过前缀进行搜索。在这种情况下，属性的顺序对于决定哪个命中最佳至关重要。

index.setSettings({
  'searchableAttributes': [
    'lastname',
    'firstname',
    'company',
    'email',
    'city',
    'address'
  ]
}, function(content, err) {
  console.log(content);
});