• A hook event that fires when Cards are dealt from a deck to other hands. returnCards

    Parameters

    • origin: Cards

      The origin Cards document.

    • returned: Card[]

      The cards being returned.

    • context: {
          toUpdate: Record<string, object[]>;
          fromDelete: object[];
      }

      Additional context which describes the operation.

      • toUpdate: Record<string, object[]>

        A mapping of Card deck IDs to the update operations that will be performed on them.

      • fromDelete: object[]

        Card deletion operations to be performed on the origin Cards document.

    Returns void