typesense dart

タイプセンス

タイプセンス検索エンジンのHTTP APIにアクセスするためのDARTクライアントライブラリ。

注：このパッケージはまだ開発中です。一部の既存のAPIが変更される可能性があるか、将来的に新しいAPIが利用可能になる可能性があります。

インストール

pubspec.yamlファイルの依存関係としてtypesenseを追加します。

 dependencies:
  typesense: ^0.5.1

使用法

ここでドキュメントを読む：https：//typesense.org/docs/api/

テストはまた、ライブラリが内部的にどのように機能するかを知るのに適した場所です：テスト

注：ユーザー向けアプリでこのライブラリを使用する場合は、 master APIキーの代わりに検索操作を許可するAPIキーを必ず使用してください。検索のみのAPIキーを生成する方法の例については、keys.dartを参照してください。

すべてのクライアント構成オプションのリストについては、Configurationクラスを参照してください。

例

 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

事前に必ず読み込むようにしてください。

互換性

タイプセンスサーバー	タイプセンスダート
> = V0.24.0	> = V0.5.0
> = V0.22.0	> = v0.3.0
> = V0.21.0	> = v0.1.1

貢献

Converting.mdにアクセスしてください

クレジット

このライブラリは、貢献者の素晴らしいコミュニティによって執筆および維持されています。

• ハッピーサン
• ハリサラン
• マフレウド