Function weighted

weighted(
    easingNameOrOptions?:
        | "bounceOut"
        | "quintIn"
        | "quintOut"
        | "arch"
        | "smoothstep"
        | "smootherstep"
        | "sineIn"
        | "sineOut"
        | "quadIn"
        | "quadOut"
        | "sineInOut"
        | "quadInOut"
        | "cubicIn"
        | "cubicOut"
        | "quartIn"
        | "quartOut"
        | "expoIn"
        | "expoOut"
        | "quintInOut"
        | "expoInOut"
        | "circIn"
        | "circOut"
        | "backIn"
        | "backOut"
        | "circInOut"
        | "backInOut"
        | "elasticIn"
        | "elasticOut"
        | "bounceIn"
        | "bell"
        | "elasticInOut"
        | "bounceInOut"
        | Readonly<
            {
                easing?: | "bounceOut"
                | "quintIn"
                | "quintOut"
                | "arch"
                | "smoothstep"
                | "smootherstep"
                | "sineIn"
                | "sineOut"
                | "quadIn"
                | "quadOut"
                | "sineInOut"
                | "quadInOut"
                | "cubicIn"
                | "cubicOut"
                | "quartIn"
                | "quartOut"
                | "expoIn"
                | "expoOut"
                | "quintInOut"
                | "expoInOut"
                | "circIn"
                | "circOut"
                | "backIn"
                | "backOut"
                | "circInOut"
                | "backInOut"
                | "elasticIn"
                | "elasticOut"
                | "bounceIn"
                | "bell"
                | "elasticInOut"
                | "bounceInOut";
                source?: RandomSource;
            },
        >,
): number
Returns a random number, 0..1, weighted by a given easing function. Default easing is quadIn, which skews towards zero.

Use weightedSource to return a function instead.
```
import * as Random from 'https://unpkg.com/ixfx/dist/random.js';
Random.weighted();          // quadIn easing by default, which skews toward low values
Random.weighted(`quadOut`); // quadOut favours high values
```
Parameters
- easingNameOrOptions:
      | "bounceOut"
      | "quintIn"
      | "quintOut"
      | "arch"
      | "smoothstep"
      | "smootherstep"
      | "sineIn"
      | "sineOut"
      | "quadIn"
      | "quadOut"
      | "sineInOut"
      | "quadInOut"
      | "cubicIn"
      | "cubicOut"
      | "quartIn"
      | "quartOut"
      | "expoIn"
      | "expoOut"
      | "quintInOut"
      | "expoInOut"
      | "circIn"
      | "circOut"
      | "backIn"
      | "backOut"
      | "circInOut"
      | "backInOut"
      | "elasticIn"
      | "elasticOut"
      | "bounceIn"
      | "bell"
      | "elasticInOut"
      | "bounceInOut"
      | Readonly<
          {
              easing?: | "bounceOut"
              | "quintIn"
              | "quintOut"
              | "arch"
              | "smoothstep"
              | "smootherstep"
              | "sineIn"
              | "sineOut"
              | "quadIn"
              | "quadOut"
              | "sineInOut"
              | "quadInOut"
              | "cubicIn"
              | "cubicOut"
              | "quartIn"
              | "quartOut"
              | "expoIn"
              | "expoOut"
              | "quintInOut"
              | "expoInOut"
              | "circIn"
              | "circOut"
              | "backIn"
              | "backOut"
              | "circInOut"
              | "backInOut"
              | "elasticIn"
              | "elasticOut"
              | "bounceIn"
              | "bell"
              | "elasticInOut"
              | "bounceInOut";
              source?: RandomSource;
          },
      > = ...
  Options. Uses 'quadIn' by default.
Returns number
Random number (0-1)

See
weightedSource Returns a function rather than value

Function weighted

Parameters

Returns number

See

Settings