typesense dart

typessense

DART客户库库，用于访问Typesense搜索引擎的HTTP API。

注意：此软件包仍在开发中。一些现有的API可能会更改，或者将来可能会提供新的API。

安装

在您的pubspec.yaml文件中添加typesense作为依赖项。

 dependencies:
  typesense: ^0.5.1

用法

在此处阅读文档：https：//typesense.org/docs/api/

测试也是了解图书馆内部工作原理的好地方：测试

注意：在面向用户的应用程序中使用此库时，请确保使用仅允许搜索操作而不是master API键的API键。有关如何仅生成搜索API密钥的示例，请参见keys.dart。

有关所有客户端配置选项的列表，请参见配置类。

例子

 import 'dart:io' ;

import 'package:typesense/typesense.dart' ;


void main () async {
  // Replace with your configuration
  final host = InternetAddress .loopbackIPv4.address, protocol = Protocol .http;
  final config = Configuration (
    // Api key
    'xyz' ,
    nodes : {
      Node (
        protocol,
        host,
        port : 7108 ,
      ),
      Node . withUri (
        Uri (
          scheme : 'http' ,
          host : host,
          port : 8108 ,
        ),
      ),
      Node (
        protocol,
        host,
        port : 9108 ,
      ),
    },
    numRetries : 3 , // A total of 4 tries (1 original try + 3 retries)
    connectionTimeout : const Duration (seconds : 2 ),
  );

  final client = Client (config);

  final searchParameters = {
    'q' : 'stark' ,
    'query_by' : 'company_name' ,
    'filter_by' : 'num_employees:>100' ,
    'sort_by' : 'num_employees:desc'
  };

  await client. collection ( 'companies' ).documents. search (searchParameters);
}

引导您了解如何使用客户的示例：main.dart

确保事先读书。

兼容性

typesenses服务器	类型义
> = V0.24.0	> = V0.5.0
> = V0.22.0	> = V0.3.0
> = V0.21.0	> = V0.1.1

贡献

访问贡献

学分

该图书馆由我们出色的撰稿人社区撰写和维护：

• 快乐山
• 哈里萨朗
• 黑手党