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

    Class CauseSearch

    Search wrapper for the public cause / fundraising-event indices hosted at site-search.tiltify.com. Use getCausesAndFundraisingEvents for the unioned causes_and_fes index, or getCauses / getFundraisingEvents for the type-specific indices.

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

    const cs = new CauseSearch();
    const results = await cs.getCausesAndFundraisingEvents({ query: "child" });

    https://site-search.tiltify.com

    Index
    constructor
    client
    getCauses getCausesAndFundraisingEvents getFundraisingEvents getFundraisingEventsByCauseFactPublicId indexFor search
    client: MeiliSearch

    • Search only the causes index.

      Parameters

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

      `await cs.getCauses({ query: "stj" })`

    • Search the unioned causes_and_fes index. This is what the marketing site's global search box queries.

      Parameters

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

      await cs.getCausesAndFundraisingEvents({ query: "stjude" });

    • Search only the fundraising_events index.

      Parameters

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

      `await cs.getFundraisingEvents({})`

    • Convenience: every fundraising event scoped to a single cause. Equivalent to filtering the FE index by cause_fact_public_id.

      Parameters

      • params: {
            causeFactPublicId: string;
            hitsPerPage?: number;
            page?: number;
            query?: string;
        }

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

      await cs.getFundraisingEventsByCauseFactPublicId({ causeFactPublicId: "fact-pid" });

    • Parameters

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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods