Skip to main content

Choice Generator

Randomly selects from a list of options, with optional weighted probabilities.

Basic Usage​

{
  "status": {
    "gen": "choice",
    "options": ["active", "inactive", "pending"]
  }
}

Output: One of: "active", "inactive", or "pending" (equal probability)

Options​

OptionTypeRequiredDescription
optionsarrayYesList of values to choose from
weightsarray of integersNoRelative weights for each option

Examples​

Simple Choice​

{
  "role": {
    "gen": "choice",
    "options": ["admin", "user", "guest"]
  }
}

Weighted Choice​

{
  "role": {
    "gen": "choice",
    "options": ["admin", "user", "guest"],
    "weights": [10, 80, 10]
  }
}

Result: 10% admin, 80% user, 10% guest

Boolean Alternative​

{
  "isActive": {
    "gen": "choice",
    "options": [true, false],
    "weights": [80, 20]
  }
}

Result: 80% true, 20% false

Nullable Values​

{
  "middleName": {
    "gen": "choice",
    "options": [null, {"gen": "name.firstName"}],
    "weights": [30, 70]
  }
}

Result: 30% null, 70% generated name

Numeric Choices​

{
  "priority": {
    "gen": "choice",
    "options": [1, 2, 3, 4, 5],
    "weights": [5, 10, 50, 25, 10]
  }
}

Common Patterns​

Status Fields​

{
  "orders": {
    "count": 100,
    "item": {
      "id": {"gen": "uuid"},
      "status": {
        "gen": "choice",
        "options": ["pending", "processing", "shipped", "delivered", "cancelled"],
        "weights": [20, 15, 30, 30, 5]
      }
    }
  }
}

User Roles​

{
  "users": {
    "count": 100,
    "item": {
      "id": {"gen": "uuid"},
      "name": {"gen": "name.fullName"},
      "role": {
        "gen": "choice",
        "options": ["admin", "moderator", "user"],
        "weights": [5, 15, 80]
      }
    }
  }
}

Priority Levels​

{
  "tickets": {
    "count": 200,
    "item": {
      "id": {"gen": "uuid"},
      "priority": {
        "gen": "choice",
        "options": ["low", "medium", "high", "critical"],
        "weights": [50, 30, 15, 5]
      }
    }
  }
}

Product Categories​

{
  "products": {
    "count": 100,
    "item": {
      "id": {"gen": "uuid"},
      "name": {"gen": "lorem.word"},
      "category": {
        "gen": "choice",
        "options": ["Electronics", "Clothing", "Books", "Home", "Sports"]
      }
    }
  }
}

Subscription Tiers​

{
  "users": {
    "count": 1000,
    "item": {
      "id": {"gen": "uuid"},
      "email": {"gen": "internet.emailAddress"},
      "tier": {
        "gen": "choice",
        "options": ["free", "basic", "premium", "enterprise"],
        "weights": [70, 20, 8, 2]
      }
    }
  }
}

Payment Methods​

{
  "transactions": {
    "count": 500,
    "item": {
      "id": {"gen": "uuid"},
      "paymentMethod": {
        "gen": "choice",
        "options": ["credit_card", "debit_card", "paypal", "bank_transfer"],
        "weights": [50, 30, 15, 5]
      }
    }
  }
}

Weighted Choice Explained​

Weights are relative, not percentages:

{
  "gen": "choice",
  "options": ["A", "B", "C"],
  "weights": [1, 2, 7]
}

Total weight: 1 + 2 + 7 = 10

  • A: 1/10 = 10%
  • B: 2/10 = 20%
  • C: 7/10 = 70%

Same result with different weights:

{
  "gen": "choice",
  "options": ["A", "B", "C"],
  "weights": [10, 20, 70]
}

Filtering​

Choice generator supports filtering:

{
  "status": {
    "gen": "choice",
    "options": ["active", "inactive", "banned", "pending"],
    "filter": ["banned"]
  }
}

Result: Only generates "active", "inactive", or "pending"

Best Practices​

  1. Use Weights for Realism: Match real-world distributions
  2. Document Weights: Comment why specific weights were chosen
  3. Consider Null: Use null in options for optional fields
  4. Enum Alternative: Use Choice for enum-like values
  5. Test Distributions: Verify weights produce expected distributions

Comparison with Other Generators​

GeneratorUse Case
ChoiceSelect from specific options
BooleanTrue/false with probability
NumberRandom integers in range
StringRandom strings

Sequential Choice​

Choice generator can cycle through options sequentially:

{
  "teams": {
    "count": 3,
    "item": {
      "id": {"gen": "uuid"},
      "name": {"gen": "choice", "options": ["Red", "Blue", "Green"]}
    }
  },
  "players": {
    "count": 30,
    "item": {
      "id": {"gen": "uuid"},
      "teamName": {
        "gen": "choice",
        "options": ["Red", "Blue", "Green"],
        "sequential": true
      }
    }
  }
}

Note: Sequential behavior is primarily for references, not the Choice generator itself.

Next Steps​