PHP's mt_rand in TypeScript

How to use

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

Or with CommonJS: const { mt_rand } = require('locutus/php/math/mt_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	mt_rand(1, 1)	1

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function mt_rand(): number

export function mt_rand(min: number | string, max: number | string): number

export function mt_rand(...providedArgs: [min?: number | string, max?: number | string]): number {
  //      discuss at: https://locutus.io/php/mt_rand/
  // parity verified: PHP 8.3
  //     original by: Onno Marsman (https://twitter.com/onnomarsman)
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //        input by: Kongo
  //       example 1: mt_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: mt_rand() expects exactly 2 parameters, 1 given')
  } else {
    minValue = Number.parseInt(String(min), 10)
    maxValue = Number.parseInt(String(max), 10)
  }

  return Math.floor(Math.random() * (maxValue - minValue + 1)) + minValue
}

export function mt_rand(...providedArgs) {
  //      discuss at: https://locutus.io/php/mt_rand/
  // parity verified: PHP 8.3
  //     original by: Onno Marsman (https://twitter.com/onnomarsman)
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //        input by: Kongo
  //       example 1: mt_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: mt_rand() expects exactly 2 parameters, 1 given')
  } else {
    minValue = Number.parseInt(String(min), 10)
    maxValue = Number.parseInt(String(max), 10)
  }

  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