{"id":19000465,"url":"https://github.com/typesense/typesense-dart","last_synced_at":"2025-04-05T23:06:12.048Z","repository":{"id":40316878,"uuid":"360745050","full_name":"typesense/typesense-dart","owner":"typesense","description":"Dart client for Typesense","archived":false,"fork":false,"pushed_at":"2025-01-23T06:24:51.000Z","size":271,"stargazers_count":76,"open_issues_count":7,"forks_count":16,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-29T22:04:42.786Z","etag":null,"topics":["dart","http-client","search-engine","typesense"],"latest_commit_sha":null,"homepage":"https://typesense.org/docs","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/typesense.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-23T02:52:05.000Z","updated_at":"2025-03-13T01:46:18.000Z","dependencies_parsed_at":"2025-03-02T18:12:32.551Z","dependency_job_id":"947b87dd-c5b6-452f-a32c-9e34db38641a","html_url":"https://github.com/typesense/typesense-dart","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Ftypesense-dart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Ftypesense-dart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Ftypesense-dart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/typesense%2Ftypesense-dart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/typesense","download_url":"https://codeload.github.com/typesense/typesense-dart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411227,"owners_count":20934653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dart","http-client","search-engine","typesense"],"created_at":"2024-11-08T18:07:18.951Z","updated_at":"2025-04-05T23:06:12.022Z","avatar_url":"https://github.com/typesense.png","language":"Dart","readme":"# Typesense\n\n [![pub package][pubShield]][package] [![github actions status][githubBadge]][githubActions] [![pub likes][pubLikesBadge]][pubScore] [![pub points][pubScoreBadge]][pubScore] [![pub downloads][pubDownloadsBadge]][pubScore]\n\nDart client library for accessing the HTTP API of [Typesense][typesense] search engine.\n\nNote: This package is still under development. Some existing APIs might change or new APIs might be available in the future.\n\n## Installation\n\nAdd `typesense` as a [dependency in your pubspec.yaml file](https://flutter.dev/using-packages/).\n\n```@yaml\ndependencies:\n  typesense: ^0.5.2\n```\n\n## Usage\n\nRead the documentation here: [https://typesense.org/docs/api/][docs]\n\nTests are also a good place to know how the library works internally: [test](test)\n\n**Note: When using this library in a user-facing app, please be sure to use an API Key that only allows search operations instead of the `master` API key.** See [keys.dart](example/console-simple/bin/keys.dart) for an example of how to generate a search only API key.\n\nSee [Configuration](lib/src/configuration.dart) class for a list of all client configuration options.\n\n### Examples\n\n\n```dart\nimport 'dart:io';\n\nimport 'package:typesense/typesense.dart';\n\n\nvoid main() async {\n  // Replace with your configuration\n  final host = InternetAddress.loopbackIPv4.address, protocol = Protocol.http;\n  final config = Configuration(\n    // Api key\n    'xyz',\n    nodes: {\n      Node(\n        protocol,\n        host,\n        port: 7108,\n      ),\n      Node.withUri(\n        Uri(\n          scheme: 'http',\n          host: host,\n          port: 8108,\n        ),\n      ),\n      Node(\n        protocol,\n        host,\n        port: 9108,\n      ),\n    },\n    numRetries: 3, // A total of 4 tries (1 original try + 3 retries)\n    connectionTimeout: const Duration(seconds: 2),\n  );\n\n  final client = Client(config);\n\n  final searchParameters = {\n    'q': 'stark',\n    'query_by': 'company_name',\n    'filter_by': 'num_employees:\u003e100',\n    'sort_by': 'num_employees:desc'\n  };\n\n  await client.collection('companies').documents.search(searchParameters);\n}\n```\n\nThe examples that walk you through on how to use the client: [main.dart](example/console-simple/bin/main.dart)\n\nMake sure to [README](example/console-simple/README.md) beforehand.\n\n## Compatibility\n\n| Typesense Server | typesense-dart |\n|------------------|----------------|\n| \\\u003e= v0.24.0 | \\\u003e= v0.5.0 |\n| \\\u003e= v0.22.0 | \\\u003e= v0.3.0 |\n| \\\u003e= v0.21.0 | \\\u003e= v0.1.1 |\n\n## Contributing\n\nVisit [CONTRIBUTING.md](CONTRIBUTING.md)\n\n## Credits\n\nThis library is authored and maintained by our awesome community of contributors:\n\n- [happy-san](https://github.com/happy-san)\n- [harisarang](https://github.com/harisarang)\n- [mafreud](https://github.com/mafreud)\n\n[nnbd]: https://github.com/typesense/typesense-dart/issues/37\n[docs]: https://typesense.org/docs/api/\n[githubBadge]: https://github.com/typesense/typesense-dart/actions/workflows/dart.yml/badge.svg\n[githubActions]: https://github.com/typesense/typesense-dart/actions\n[pubShield]: https://img.shields.io/pub/v/typesense.svg\n[package]: https://pub.dev/packages/typesense\n[codecovBadge]: https://codecov.io/gh/typesense/typesense-dart/branch/master/graph/badge.svg?token=UV6MPDKS07\n[codecov]: https://codecov.io/gh/typesense/typesense-dart\n[pubScoreBadge]: https://img.shields.io/pub/points/typesense\n[pubScore]: https://pub.dev/packages/typesense/score\n[typesense]: https://github.com/typesense/typesense\n[pubLikesBadge]: https://img.shields.io/pub/likes/typesense\n[pubDownloadsBadge]: https://img.shields.io/pub/dm/typesense\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Ftypesense-dart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypesense%2Ftypesense-dart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypesense%2Ftypesense-dart/lists"}