Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/igrek8/typesense-utils

Utitility functions to tackle query generation in typesense
https://github.com/igrek8/typesense-utils

query query-builders typesense

Last synced: about 2 months ago
JSON representation

Utitility functions to tackle query generation in typesense

Host: GitHub
URL: https://github.com/igrek8/typesense-utils
Owner: igrek8
Created: 2023-03-19T15:56:34.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-05-13T20:30:00.000Z (8 months ago)
Last Synced: 2024-12-03T00:41:29.714Z (about 2 months ago)
Topics: query, query-builders, typesense
Language: TypeScript
Homepage:
Size: 1.38 MB
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # typesense-utils (tested typesense@^0.24.0)

[![flow-stage](https://github.com/igrek8/typesense-utils/actions/workflows/flow-stage.yml/badge.svg)](https://github.com/igrek8/typesense-utils/actions/workflows/flow-stage.yml)

[![codecov](https://codecov.io/gh/igrek8/typesense-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/igrek8/typesense-utils)

Utilities to build various queries in [Typesense](https://typesense.org/).

## Installation

```bash

npm i typesense-utils --save-dev --save-exact

yarn add typesense-utils --exact

```

## Usage

- [buildFieldsList.ts](./src/buildFieldsList.test.ts)

- [buildQueryBy.ts](./src/buildQueryBy.test.ts)

- [buildFilterBy.ts](./src/buildFilterBy.test.ts)

- [buildSortBy.ts](./src/buildSortBy.test.ts)

- [buildGroupBy.ts](./src/buildGroupBy.test.ts)

- [buildFacetBy.ts](./src/buildFacetBy.test.ts)

- [buildFacetQuery.ts](./src/buildFacetQuery.test.ts)

- [buildVectorQuery.ts](./src/buildVectorQuery.test.ts)