PHP's uniqid in TypeScript

How to use

Install via yarn add locutus and import: import { uniqid } from 'locutus/php/misc/uniqid'.

Or with CommonJS: const { uniqid } = require('locutus/php/misc/uniqid')

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	var $id = uniqid() var $result = $id.length === 13	true
2	var $id = uniqid('foo') var $result = $id.length === (13 + 'foo'.length)	true
3	var $id = uniqid('bar', true) var $result = $id.length === (23 + 'bar'.length)	true

Notes

• Uses an internal counter (in locutus global) to avoid collision

Dependencies

This function uses the following Locutus functions:

• _phpRuntimeState (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { getPhpRuntimeNumber, setPhpRuntimeEntry } from '../_helpers/_phpRuntimeState.ts'

export function uniqid(prefix?: string, moreEntropy?: boolean): string {
  //  discuss at: https://locutus.io/php/uniqid/
  // original by: Kevin van Zonneveld (https://kvz.io)
  //  revised by: Kankrelune (https://www.webfaktory.info/)
  //      note 1: Uses an internal counter (in locutus global) to avoid collision
  //   example 1: var $id = uniqid()
  //   example 1: var $result = $id.length === 13
  //   returns 1: true
  //   example 2: var $id = uniqid('foo')
  //   example 2: var $result = $id.length === (13 + 'foo'.length)
  //   returns 2: true
  //   example 3: var $id = uniqid('bar', true)
  //   example 3: var $result = $id.length === (23 + 'bar'.length)
  //   returns 3: true

  const normalizedPrefix = prefix ?? ''

  let retId = ''
  const formatSeed = (seed: number, reqWidth: number): string => {
    const hexSeed = Number.parseInt(String(seed), 10).toString(16) // to hex str
    if (reqWidth < hexSeed.length) {
      // so long we split
      return hexSeed.slice(hexSeed.length - reqWidth)
    }
    if (reqWidth > hexSeed.length) {
      // so short we pad
      return new Array(1 + (reqWidth - hexSeed.length)).join('0') + hexSeed
    }
    return hexSeed
  }

  let uniqidSeed = getPhpRuntimeNumber('uniqidSeed', Math.floor(Math.random() * 0x75bcd15)) // init seed with big random int
  uniqidSeed++
  setPhpRuntimeEntry('uniqidSeed', uniqidSeed)

  // start with prefix, add current milliseconds hex string
  retId = normalizedPrefix
  retId += formatSeed(Number.parseInt(String(new Date().getTime() / 1000), 10), 8)
  // add seed hex string
  retId += formatSeed(uniqidSeed, 5)
  if (moreEntropy) {
    // for more entropy we add a float lower to 10
    retId += (Math.random() * 10).toFixed(8).toString()
  }

  return retId
}

import { getPhpRuntimeNumber, setPhpRuntimeEntry } from '../_helpers/_phpRuntimeState.ts'

export function uniqid(prefix, moreEntropy) {
  //  discuss at: https://locutus.io/php/uniqid/
  // original by: Kevin van Zonneveld (https://kvz.io)
  //  revised by: Kankrelune (https://www.webfaktory.info/)
  //      note 1: Uses an internal counter (in locutus global) to avoid collision
  //   example 1: var $id = uniqid()
  //   example 1: var $result = $id.length === 13
  //   returns 1: true
  //   example 2: var $id = uniqid('foo')
  //   example 2: var $result = $id.length === (13 + 'foo'.length)
  //   returns 2: true
  //   example 3: var $id = uniqid('bar', true)
  //   example 3: var $result = $id.length === (23 + 'bar'.length)
  //   returns 3: true

  const normalizedPrefix = prefix ?? ''

  let retId = ''
  const formatSeed = (seed, reqWidth) => {
    const hexSeed = Number.parseInt(String(seed), 10).toString(16) // to hex str
    if (reqWidth < hexSeed.length) {
      // so long we split
      return hexSeed.slice(hexSeed.length - reqWidth)
    }
    if (reqWidth > hexSeed.length) {
      // so short we pad
      return new Array(1 + (reqWidth - hexSeed.length)).join('0') + hexSeed
    }
    return hexSeed
  }

  let uniqidSeed = getPhpRuntimeNumber('uniqidSeed', Math.floor(Math.random() * 0x75bcd15)) // init seed with big random int
  uniqidSeed++
  setPhpRuntimeEntry('uniqidSeed', uniqidSeed)

  // start with prefix, add current milliseconds hex string
  retId = normalizedPrefix
  retId += formatSeed(Number.parseInt(String(new Date().getTime() / 1000), 10), 8)
  // add seed hex string
  retId += formatSeed(uniqidSeed, 5)
  if (moreEntropy) {
    // for more entropy we add a float lower to 10
    retId += (Math.random() * 10).toFixed(8).toString()
  }

  return retId
}

// php/_helpers/_phpTypes (Locutus helper dependency)
type PhpNullish = null | undefined

type PhpInput = {} | PhpNullish

type PhpList<T = PhpInput> = T[]

type PhpAssoc<T = PhpInput> = { [key: string]: T }

// php/_helpers/_phpRuntimeState (Locutus helper dependency)
interface IniEntry {
  local_value?: PhpInput
}

type LocaleEntry = PhpAssoc<PhpInput> & {
  sorting?: (left: PhpInput, right: PhpInput) => number
}

type LocaleCategoryMap = PhpAssoc<string | undefined>

interface LocutusRuntimeContainer {
  php?: PhpAssoc<PhpInput>
}

interface PhpRuntimeKnownEntryMap {
  ini: PhpAssoc<IniEntry | undefined>
  locales: PhpAssoc<LocaleEntry | undefined>
  localeCategories: LocaleCategoryMap
  pointers: PhpList<PhpInput>
  locale_default: string
  locale: string
  uniqidSeed: number
  timeoutStatus: boolean
  last_error_json: number
  strtokleftOver: string
}

type PhpRuntimeNumberKey = {
  [K in keyof PhpRuntimeKnownEntryMap]: PhpRuntimeKnownEntryMap[K] extends number ? K : never
}[keyof PhpRuntimeKnownEntryMap]

type GlobalWithLocutus = {
  $locutus?: LocutusRuntimeContainer
  [key: string]: PhpInput
}

const globalContext: GlobalWithLocutus =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

const ensurePhpRuntimeObject = (): PhpAssoc<PhpInput> => {
  let locutus = globalContext.$locutus
  if (typeof locutus !== 'object' || locutus === null) {
    locutus = {}
    globalContext.$locutus = locutus
  }

  let php = locutus.php
  if (typeof php !== 'object' || php === null) {
    php = {}
    locutus.php = php
  }

  return php
}

function getPhpRuntimeEntry<TKey extends keyof PhpRuntimeKnownEntryMap>(
  key: TKey,
): PhpRuntimeKnownEntryMap[TKey] | undefined

function getPhpRuntimeEntry(key: string): PhpInput | undefined

function getPhpRuntimeEntry(key: string): PhpInput | undefined {
  const php = ensurePhpRuntimeObject()
  const value = php[key]
  return typeof value === 'undefined' ? undefined : value
}

function setPhpRuntimeEntry<TKey extends keyof PhpRuntimeKnownEntryMap>(
  key: TKey,
  value: PhpRuntimeKnownEntryMap[TKey],
): void

function setPhpRuntimeEntry(key: string, value: PhpInput): void

function setPhpRuntimeEntry(key: string, value: PhpInput): void {
  const php = ensurePhpRuntimeObject()
  php[key] = value
}

function getPhpRuntimeNumber(key: PhpRuntimeNumberKey, fallback: number): number

function getPhpRuntimeNumber(key: string, fallback: number): number

function getPhpRuntimeNumber(key: string, fallback: number): number {
  const value = getPhpRuntimeEntry(key)
  return typeof value === 'number' ? value : fallback
}

// php/misc/uniqid (target function module)
function uniqid(prefix?: string, moreEntropy?: boolean): string {
  //  discuss at: https://locutus.io/php/uniqid/
  // original by: Kevin van Zonneveld (https://kvz.io)
  //  revised by: Kankrelune (https://www.webfaktory.info/)
  //      note 1: Uses an internal counter (in locutus global) to avoid collision
  //   example 1: var $id = uniqid()
  //   example 1: var $result = $id.length === 13
  //   returns 1: true
  //   example 2: var $id = uniqid('foo')
  //   example 2: var $result = $id.length === (13 + 'foo'.length)
  //   returns 2: true
  //   example 3: var $id = uniqid('bar', true)
  //   example 3: var $result = $id.length === (23 + 'bar'.length)
  //   returns 3: true

  const normalizedPrefix = prefix ?? ''

  let retId = ''
  const formatSeed = (seed: number, reqWidth: number): string => {
    const hexSeed = Number.parseInt(String(seed), 10).toString(16) // to hex str
    if (reqWidth < hexSeed.length) {
      // so long we split
      return hexSeed.slice(hexSeed.length - reqWidth)
    }
    if (reqWidth > hexSeed.length) {
      // so short we pad
      return new Array(1 + (reqWidth - hexSeed.length)).join('0') + hexSeed
    }
    return hexSeed
  }

  let uniqidSeed = getPhpRuntimeNumber('uniqidSeed', Math.floor(Math.random() * 0x75bcd15)) // init seed with big random int
  uniqidSeed++
  setPhpRuntimeEntry('uniqidSeed', uniqidSeed)

  // start with prefix, add current milliseconds hex string
  retId = normalizedPrefix
  retId += formatSeed(Number.parseInt(String(new Date().getTime() / 1000), 10), 8)
  // add seed hex string
  retId += formatSeed(uniqidSeed, 5)
  if (moreEntropy) {
    // for more entropy we add a float lower to 10
    retId += (Math.random() * 10).toFixed(8).toString()
  }

  return retId
}

// php/_helpers/_phpRuntimeState (Locutus helper dependency)
const globalContext =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

const ensurePhpRuntimeObject = () => {
  let locutus = globalContext.$locutus
  if (typeof locutus !== 'object' || locutus === null) {
    locutus = {}
    globalContext.$locutus = locutus
  }

  let php = locutus.php
  if (typeof php !== 'object' || php === null) {
    php = {}
    locutus.php = php
  }

  return php
}

function getPhpRuntimeEntry(key) {
  const php = ensurePhpRuntimeObject()
  const value = php[key]
  return typeof value === 'undefined' ? undefined : value
}

function setPhpRuntimeEntry(key, value) {
  const php = ensurePhpRuntimeObject()
  php[key] = value
}

function getPhpRuntimeNumber(key, fallback) {
  const value = getPhpRuntimeEntry(key)
  return typeof value === 'number' ? value : fallback
}

// php/misc/uniqid (target function module)
function uniqid(prefix, moreEntropy) {
  //  discuss at: https://locutus.io/php/uniqid/
  // original by: Kevin van Zonneveld (https://kvz.io)
  //  revised by: Kankrelune (https://www.webfaktory.info/)
  //      note 1: Uses an internal counter (in locutus global) to avoid collision
  //   example 1: var $id = uniqid()
  //   example 1: var $result = $id.length === 13
  //   returns 1: true
  //   example 2: var $id = uniqid('foo')
  //   example 2: var $result = $id.length === (13 + 'foo'.length)
  //   returns 2: true
  //   example 3: var $id = uniqid('bar', true)
  //   example 3: var $result = $id.length === (23 + 'bar'.length)
  //   returns 3: true

  const normalizedPrefix = prefix ?? ''

  let retId = ''
  const formatSeed = (seed, reqWidth) => {
    const hexSeed = Number.parseInt(String(seed), 10).toString(16) // to hex str
    if (reqWidth < hexSeed.length) {
      // so long we split
      return hexSeed.slice(hexSeed.length - reqWidth)
    }
    if (reqWidth > hexSeed.length) {
      // so short we pad
      return new Array(1 + (reqWidth - hexSeed.length)).join('0') + hexSeed
    }
    return hexSeed
  }

  let uniqidSeed = getPhpRuntimeNumber('uniqidSeed', Math.floor(Math.random() * 0x75bcd15)) // init seed with big random int
  uniqidSeed++
  setPhpRuntimeEntry('uniqidSeed', uniqidSeed)

  // start with prefix, add current milliseconds hex string
  retId = normalizedPrefix
  retId += formatSeed(Number.parseInt(String(new Date().getTime() / 1000), 10), 8)
  // add seed hex string
  retId += formatSeed(uniqidSeed, 5)
  if (moreEntropy) {
    // for more entropy we add a float lower to 10
    retId += (Math.random() * 10).toFixed(8).toString()
  }

  return retId
}

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 misc functions

Star