$choose

Chooses one element from an array of possible choices with uniform probability. Optionally chooses with probability proportional to a provided weights array.

Options

• from (required) Array of values or operators to choose from.
• weights (optional) Array of weightings (must be the same length as from).

Example

Template

{
    "status": {
        "$choose": {
            "from": ["read", "unread", "deleted"],
            "weights": [2, 1, 1]
        }
    }
}

Output Probability 50%

{
    "status": "read"
}

Output Probability 25%

{
    "status": "unread"
}

Output Probability 25%

{
    "status": "deleted"
}