Class TeamSearch

Search wrapper for the public teams Meilisearch index hosted at site-search.tiltify.com.

Example

import { TeamSearch } from "@playlive/tiltify-search";

const ts = new TeamSearch();
const { hits } = await ts.findTeamByTeamName("Simsie Squad");

See

https://site-search.tiltify.com

Index

Constructors

constructor

new TeamSearch(
    apiKey?: string,
    host?: string,
    httpClientOptions?: ResilientHttpClientOptions,
): TeamSearch
Parameters
- apiKey: string = DEFAULT_SEARCH_API_KEY
  Public Meilisearch key. Defaults to DEFAULT_SEARCH_API_KEY.
- host: string = DEFAULT_SEARCH_HOST
  Meilisearch host. Defaults to DEFAULT_SEARCH_HOST.
- OptionalhttpClientOptions: ResilientHttpClientOptions
  Optional overrides for the resilient httpClient (retry/backoff, logging hook). See ResilientHttpClientOptions.
Returns TeamSearch
- Defined in packages/tiltify/search/src/team-search.ts:32

Properties

`Protected`client

client: MeiliSearch

`Protected`index

index: Index

Methods

findTeamByTeamName

findTeamByTeamName(
    teamName: string,
    hitsPerPage?: number,
    page?: number,
): Promise<
    SearchResponse<
        { id: string },
        {
            attributesToHighlight: string[];
            filter: string;
            hitsPerPage: number;
            page: number;
            totalHits?: number;
        },
    >,
>
Find teams by exact name match.
Parameters
- teamName: string
  The team name to search for.
- hitsPerPage: number = 100
  Page size. Defaults to 100.
- page: number = 1
  1-based page index. Defaults to 1.
Returns Promise<
    SearchResponse<
        { id: string },
        {
            attributesToHighlight: string[];
            filter: string;
            hitsPerPage: number;
            page: number;
            totalHits?: number;
        },
    >,
>
The Meilisearch search response.
Example
```
const { hits } = await ts.findTeamByTeamName("Simsie Squad", 25, 1);
```
- Defined in packages/tiltify/search/src/team-search.ts:53

Class TeamSearch

Example

See

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TeamSearch

Properties

`Protected`client

`Protected`index

Methods

findTeamByTeamName

Parameters

Returns Promise<
    SearchResponse<
        { id: string },
        {
            attributesToHighlight: string[];
            filter: string;
            hitsPerPage: number;
            page: number;
            totalHits?: number;
        },
    >,
>

Example

Settings

On This Page

Class TeamSearch

Example

See

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TeamSearch

Properties

Protectedclient

Protectedindex

Methods

findTeamByTeamName

Parameters

Returns Promise< SearchResponse< { id: string }, { attributesToHighlight: string[]; filter: string; hitsPerPage: number; page: number; totalHits?: number; }, >,>

Example

Settings

On This Page

`Protected`client

`Protected`index

Returns Promise<
SearchResponse<
{ id: string },
{
attributesToHighlight: string[];
filter: string;
hitsPerPage: number;
page: number;
totalHits?: number;
},
>,
>