Class SearchResult

One page of search results, plus helpers to paginate and to discover the filters available for the current query/category.

Index

Constructors

Accessors

availableFilters galleryListings hasNextPage listings pageInfo searchToken totalCount

Methods

next paginate raw

Constructors

constructor

new SearchResult(
builder: SearchBuilder,
root: ListingSearchResult,
): SearchResult
Parameters
- builder: SearchBuilder
- root: ListingSearchResult
Returns SearchResult
- Defined in src/search/result.ts:12

Accessors

availableFilters

get availableFilters(): Filter[]
Filters available for this query/category (names, labels, options).

Returns Filter[]
- Defined in src/search/result.ts:33

galleryListings

get galleryListings(): Listing[]
Featured/hero listings returned alongside the result set.

Returns Listing[]
- Defined in src/search/result.ts:28

hasNextPage

get hasNextPage(): boolean
Returns boolean
- Defined in src/search/result.ts:48

listings

get listings(): Listing[]
Listings on this page.

Returns Listing[]
- Defined in src/search/result.ts:23

pageInfo

get pageInfo(): PageInfo
Returns PageInfo
- Defined in src/search/result.ts:42

searchToken

get searchToken(): string | null
Opaque token to browse this category via client.browse(token).

Returns string | null
- Defined in src/search/result.ts:38

totalCount

get totalCount(): number
Total matching listings server-side (across all pages).

Returns number
- Defined in src/search/result.ts:18

Methods

next

next(): Promise<SearchResult | null>
Fetch the next page, or null if there is none.

Returns Promise<SearchResult | null>
- Defined in src/search/result.ts:53

paginate

paginate(): AsyncGenerator<Listing>
Async-iterate every listing across all pages.

Returns AsyncGenerator<Listing>
- Defined in src/search/result.ts:60

raw

raw(): ListingSearchResult
The raw, unmodeled response root (escape hatch).

Returns ListingSearchResult
- Defined in src/search/result.ts:69