PHP's rand in TypeScript

How to use

Install via yarn add locutus and import: import { rand } from 'locutus/php/math/rand'.

Or with CommonJS: const { rand } = require('locutus/php/math/rand')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	rand(1, 1)	1

Notes

• See the commented out code below for a version which will work with our experimental (though probably unnecessary) srand() function)

Here's what our current TypeScript equivalent to PHP's rand looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function rand(): number

export function rand(min: number, max: number): number

export function rand(...providedArgs: [min?: number, max?: number]): number {
  //      discuss at: https://locutus.io/php/rand/
  // parity verified: PHP 8.3
  //     original by: Leslie Hoare
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //          note 1: See the commented out code below for a version which
  //          note 1: will work with our experimental (though probably unnecessary)
  //          note 1: srand() function)
  //       example 1: rand(1, 1)
  //       returns 1: 1

  const [min, max] = providedArgs
  let minValue: number
  let maxValue: number
  if (providedArgs.length === 0) {
    minValue = 0
    maxValue = 2147483647
  } else if (providedArgs.length === 1) {
    throw new Error('Warning: rand() expects exactly 2 parameters, 1 given')
  } else {
    minValue = Number(min)
    maxValue = Number(max)
  }
  return Math.floor(Math.random() * (maxValue - minValue + 1)) + minValue
}

export function rand(...providedArgs) {
  //      discuss at: https://locutus.io/php/rand/
  // parity verified: PHP 8.3
  //     original by: Leslie Hoare
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //          note 1: See the commented out code below for a version which
  //          note 1: will work with our experimental (though probably unnecessary)
  //          note 1: srand() function)
  //       example 1: rand(1, 1)
  //       returns 1: 1

  const [min, max] = providedArgs
  let minValue
  let maxValue
  if (providedArgs.length === 0) {
    minValue = 0
    maxValue = 2147483647
  } else if (providedArgs.length === 1) {
    throw new Error('Warning: rand() expects exactly 2 parameters, 1 given')
  } else {
    minValue = Number(min)
    maxValue = Number(max)
  }
  return Math.floor(Math.random() * (maxValue - minValue + 1)) + minValue
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

« More PHP math functions

Star