@playlive/tiltify-search
    Preparing search index...

    Class AuctionHouseSearch

    Search wrapper for the facts Meilisearch index scoped to auction_house records. The getAuctionHouses method accepts the public id of any cause; AuctionHouseSearch.getStJudeAuctionHouses is a small convenience that pre-fills the St. Jude cause id.

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

    const ah = new AuctionHouseSearch();
    const stjude = await ah.getStJudeAuctionHouses({ hitsPerPage: 5 });
    Index
    client: MeiliSearch
    index: Index<FactHit>
    • Search for auction houses scoped to a specific cause.

      Parameters

      • __namedParameters: {
            campaignFactPublicId?: string;
            causePublicId: string;
            hitsPerPage?: number;
            page?: number;
            query?: string;
            username?: string;
        }

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

      await ah.getAuctionHouses({ causePublicId: "cause-id", username: "fauxretro" });
      
    • Convenience wrapper around AuctionHouseSearch.getAuctionHouses that pre-fills the St. Jude cause id from CAUSE_IDS.ST_JUDE.

      Parameters

      • __namedParameters: {
            campaignFactPublicId?: string;
            hitsPerPage?: number;
            page?: number;
            query?: string;
            username?: string;
        } = {}

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

      await ah.getStJudeAuctionHouses({ hitsPerPage: 10 });