Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Randomator<T>

Type parameters

  • T = unknown

Hierarchy

  • Function
    • Randomator

Implements

  • Iterator<T>

Callable

  • Randomator(): T

Index

Constructors

Properties

arguments: any
caller: Function
length: number
name: string

Returns the name of the function. Function names are read-only and can not be changed.

prototype: any

Accessors

Methods

  • [hasInstance](value: any): boolean
  • Determines whether the given value inherits from this function if this function was used as a constructor function.

    A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

    Parameters

    • value: any

    Returns boolean

  • [iterator](): Iterator<T, any, undefined>
  • ap(value: unknown): T
  • Returns a random value, whose initial value (pre-mapped) is now the passed value

    Parameters

    • value: unknown

      A value

    Returns T

  • apply(thisArg: any, argArray?: any): any
  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    Parameters

    • thisArg: any

      The object to be used as the this object.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

  • bind(thisArg: any, ...argArray: any[]): any
  • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    Parameters

    • thisArg: any

      An object to which the this keyword can refer inside the new function.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the new function.

    Returns any

  • call(thisArg: any, ...argArray: any[]): any
  • Calls a method of an object, substituting another object for the current object.

    Parameters

    • thisArg: any

      The object to be used as the current object.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

  • filter(predicate: (_: T) => boolean): Randomator<T>
  • Returns a new Randomator with that returns only values that pass the predicate

    Parameters

    • predicate: (_: T) => boolean
        • (_: T): boolean
        • Parameters

          • _: T

          Returns boolean

    Returns Randomator<T>

  • next(): IteratorYieldResult<T>
  • Returns a random value as a iterator object

    Returns IteratorYieldResult<T>

  • toArray(length: number): T[]
  • Returns an array of random values

    Parameters

    • length: number

      length of the resulting array

    Returns T[]

  • toString(): string

Generated using TypeDoc