Function sampleSize

  • sampleSize<T>(collection, n?, guard?): T[]

  • Gets n random elements at unique keys from array up to the size of array.

    Type Parameters

    • T

    Parameters

    • collection: Collection<T>

      The array to sample.

    • n: number = 1

      The number of elements to sample.

    • Optionalguard: any

    Returns T[]

    Returns the random elements.

    Since

    5.11.0

    Example

    sampleSize([1, 2, 3], 2)
    // => [3, 1]

    sampleSize([1, 2, 3], 4)
    // => [2, 3, 1]

Settings

Member Visibility