import type { PhpAssoc, PhpRuntimeValue } from '../_helpers/_phpTypes.ts'
import { explode } from '../strings/explode.ts'

type SplitValue = PhpRuntimeValue
type KeyedValues = PhpAssoc<SplitValue>

export function split(
  delimiter: string | boolean | null | undefined,
  string: string | KeyedValues | (() => SplitValue) | undefined,
): string[] | false | { 0: string } | null {
  //      discuss at: https://locutus.io/php/split/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: split(' ', 'Kevin van Zonneveld')
  //       returns 1: ['Kevin', 'van', 'Zonneveld']

  return explode(delimiter, string)
}