Class MatchMaker

Readonlyid

delete

• delete(): Promise<void>

  Deletes the matchmaker and all its associated data.

  Returns Promise<void>

deleteEntity

• deleteEntity(entityId: string): Promise<void>

  Deletes a specific entity from the matchmaker.

  Parameters

  • entityId: string

    The ID of the entity to delete.

  Returns Promise<void>

findMatches

• findMatches(
      entityId: string,
      options?: MmFindMatchesOptions,
  ): Promise<MmEntityMatch[]>

  Finds matches for an entity already inserted into the matchmaker.

  Parameters

  • entityId: string

    ID of the entity to match.
  • options: MmFindMatchesOptions = {}

    Optional filters and controls for matching.

  Returns Promise<MmEntityMatch[]>

  Array of entity matches.

findMatchesForEntity

• findMatchesForEntity(
      entity: Omit<MmEntity, "id" | "metadata">,
      options?: MmFindMatchesOptions,
  ): Promise<MmEntityMatch[]>

  Finds matches for an entity not yet inserted into the matchmaker.

  Parameters

  • entity: Omit<MmEntity, "id" | "metadata">

    The entity object (excluding ID and metadata).
  • options: MmFindMatchesOptions = {}

    Optional filters and controls for matching.

  Returns Promise<MmEntityMatch[]>

  Array of entity matches.

getEntity

• getEntity(entityId: string): Promise<undefined | MmEntity>

  Retrieves a single entity from the matchmaker by its ID.

  Parameters

  • entityId: string

    ID of the entity to retrieve.

  Returns Promise<undefined | MmEntity>

  The entity if found, or undefined.

getMatchMakerDetails

• getMatchMakerDetails(): MmMatchMaker

  Returns the matchmaker metadata including description, categories, and ID.

  Returns MmMatchMaker

insertEntity

• insertEntity(entity: MmEntity): Promise<void>

  Adds a new entity to the matchmaker, replacing existing entity with the same ID if it exists.

  Parameters

  • entity: MmEntity

    The entity to insert.

  Returns Promise<void>

insertManyEntities

• insertManyEntities(entities: MmEntity[]): Promise<void>

  Inserts multiple entities into the matchmaker. Replaces existing entities with matching IDs.

  Parameters

  • entities: MmEntity[]

    Array of entities to insert.

  Returns Promise<void>

listEntities

• listEntities(
      categoryId: string,
      options?: MmListEntitiesOptions,
  ): Promise<MmEntity[]>

  Lists entities currently in the matchmaker that belong to the specified category.

  Parameters

  • categoryId: string

    The category to filter entities by.
  • options: MmListEntitiesOptions = {}

    Pagination and filtering options.

  Returns Promise<MmEntity[]>

  Array of entities in the category.