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

    Parameters

    • origin: documents.Cards

      The origin Cards document.

    • returned: documents.Card[]

      The cards being returned.

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

      Additional context which describes the operation.

      • fromDelete: object[]

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

      • toUpdate: Record<string, object[]>

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

    Returns void