chore: wip

glennmichael123 · glennmichael123 · commit 11385b5b68e8 · 2025-04-29T18:39:58.000+08:00
diff --git a/src/lib/contains.ts b/src/lib/contains.ts
@@ -1,3 +1,4 @@
+import type { ContainsOptions } from '../types'
 import assertString from './util/assertString'
 import merge from './util/merge'
 import toString from './util/toString'
@@ -7,11 +8,6 @@ const defaultContainsOptions = {
   minOccurrences: 1,
 }
 
-interface ContainsOptions {
-  ignoreCase: boolean
-  minOccurrences: number
-}
-
 /**
  * contains
  *
diff --git a/src/lib/isAfter.ts b/src/lib/isAfter.ts
@@ -1,9 +1,6 @@
+import type { IsAfterOptions } from './types'
 import toDate from './toDate'
 
-export interface IsAfterOptions {
-  comparisonDate?: string | number | Date
-}
-
 /**
  * Check if the string is After
  *
diff --git a/src/lib/isAlpha.ts b/src/lib/isAlpha.ts
@@ -1,10 +1,7 @@
+import type { IsAlphaOptions } from './types'
 import { alpha } from './alpha'
 import assertString from './util/assertString'
 
-interface IsAlphaOptions {
-  ignore?: string | RegExp
-}
-
 export default function isAlpha(_str, locale = 'en-US', options: IsAlphaOptions = {}) {
   assertString(_str)
 
diff --git a/src/lib/isAlphanumeric.ts b/src/lib/isAlphanumeric.ts
@@ -1,3 +1,4 @@
+import type { AlphanumericOptions, LocaleInstance } from '../types'
 import assertString from './util/assertString'
 
 // Common alphanumeric patterns for different locales
@@ -35,18 +36,11 @@ export const alphanumeric: Record<string, RegExp> = {
   'he': /^[0-9\u05D0-\u05EA]+$/,
   'hi-IN': /^[\u0900-\u0961\u0966-\u097F]+$/,
   // eslint-disable-next-line no-misleading-character-class
-  'ur-PK': /^[\u0600-\u06FF\u0750-\u077F\u0590-\u05FF\u08A0-\u08FF\uFB50-\uFDFF\uFE70-\uFEFF\u0900-\u097F\u0980-\u09FF\u0A00-\u0A7F\u0A80-\u0AFF\u0B00-\u0B7F\u0B80-\u0BFF\u0C00-\u0C7F\u0C80-\u0CFF\u0D00-\u0D7F\u0D80-\u0DFF\u0E00-\u0E7F\u0E80-\u0EFF\u0F00-\u0FFF\u1000-\u109F\u10A0-\u10FF\u1100-\u11FF\u1200-\u137F\u1380-\u139F\u13A0-\u13FF\u1400-\u167F\u1680-\u169F\u16A0-\u16FF\u1700-\u171F\u1720-\u173F\u1740-\u175F\u1760-\u177F\u1780-\u17FF\u1800-\u18AF\u1900-\u194F\u1950-\u197F\u1980-\u19DF\u19E0-\u19FF\u1A00-\u1A1F\u1B00-\u1B7F\u1D00-\u1D7F\u1D80-\u1DBF\u1DC0-\u1DFF\u1E00-\u1EFF\u1F00-\u1FFF\u20D0-\u20FF\u2100-\u214F\u2C00-\u2C5F\u2C60-\u2C7F\u2C80-\u2CFF\u2D00-\u2D2F\u2D30-\u2D7F\u2D80-\u2DDF\u2F00-\u2FDF\u3040-\u309F\u30A0-\u30FF\u3100-\u312F\u3130-\u318F\u31A0-\u31BF\u31F0-\u31FF\u3200-\u32FF\u3300-\u33FF\u3400-\u4DBF\u4DC0-\u4DFF\u4E00-\u9FFF\uA000-\uA48F\uA490-\uA4CF\uA500-\uA63F\uA640-\uA69F\uA6A0-\uA6FF\uA700-\uA71F\uA720-\uA7FF\uA800-\uA82F\uA840-\uA87F\uA880-\uA8DF\uA900-\uA92F\uA930-\uA95F\uA960-\uA97F\uA980-\uA9DF\uAA00-\uAA5F\uAA60-\uAA7F\uAA80-\uAADF\uAB00-\uAB2F\uABC0-\uABFF\uAC00-\uD7AF\uD800-\uFA2F\uFA30-\uFA6F\uFA70-\uFADF\uFB00-\uFB4F\uFF10-\uFF19\uFF21-\uFF3A\uFF41-\uFF5A\uFF66-\uFFBE\uFFC2-\uFFC7\uFFCA-\uFFCF\uFFD2-\uFFD7\uFFDA-\uFFDC]+$/
+  'ur-PK': /^[\u0600-\u06FF\u0750-\u077F\u0590-\u05FF\u08A0-\u08FF\uFB50-\uFDFF\uFE70-\uFEFF\u0900-\u097F\u0980-\u09FF\u0A00-\u0A7F\u0A80-\u0AFF\u0B00-\u0B7F\u0B80-\u0BFF\u0C00-\u0C7F\u0C80-\u0CFF\u0D00-\u0D7F\u0D80-\u0DFF\u0E00-\u0E7F\u0E80-\u0EFF\u0F00-\u0FFF\u1000-\u109F\u10A0-\u10FF\u1100-\u11FF\u1200-\u137F\u1380-\u139F\u13A0-\u13FF\u1400-\u167F\u1680-\u169F\u16A0-\u16FF\u1700-\u171F\u1720-\u173F\u1740-\u175F\u1760-\u177F\u1780-\u17FF\u1800-\u18AF\u1900-\u194F\u1950-\u197F\u1980-\u19DF\u19E0-\u19FF\u1A00-\u1A1F\u1B00-\u1B7F\u1D00-\u1D7F\u1D80-\u1DBF\u1DC0-\u1DFF\u1E00-\u1EFF\u1F00-\u1FFF\u20D0-\u20FF\u2100-\u214F\u2C00-\u2C5F\u2C60-\u2C7F\u2C80-\u2CFF\u2D00-\u2D2F\u2D30-\u2D7F\u2D80-\u2DDF\u2F00-\u2FDF\u3040-\u309F\u30A0-\u30FF\u3100-\u312F\u3130-\u318F\u31A0-\u31BF\u31F0-\u31FF\u3200-\u32FF\u3300-\u33FF\u3400-\u4DBF\u4DC0-\u4DFF\u4E00-\u9FFF\uA000-\uA48F\uA490-\uA4CF\uA500-\uA63F\uA640-\uA69F\uA6A0-\uA6FF\uA700-\uA71F\uA720-\uA7FF\uA800-\uA82F\uA840-\uA87F\uA880-\uA8DF\uA900-\uA92F\uA930-\uA95F\uA960-\uA97F\uA980-\uA9DF\uAA00-\uAA5F\uAA60-\uAA7F\uAA80-\uAADF\uAB00-\uAB2F\uABC0-\uABFF\uAC00-\uD7AF\uD800-\uFA2F\uFA30-\uFA6F\uFA70-\uFADF\uFB00-\uFB4F\uFF10-\uFF19\uFF21-\uFF3A\uFF41-\uFF5A\uFF66-\uFFBE\uFFC2-\uFFC7\uFFCA-\uFFCF\uFFD2-\uFFD7\uFFDA-\uFFDC]+$/,
 } as const
 
-type LocaleInstance = keyof typeof alphanumeric
-
 export const locales = Object.keys(alphanumeric) as LocaleInstance[]
 
-export interface AlphanumericOptions {
-  ignore?: string | RegExp
-  locale?: LocaleInstance
-}
-
 /**
  * Check if the string contains only alphanumeric characters (letters and numbers).
  *
diff --git a/src/lib/isBase32.ts b/src/lib/isBase32.ts
@@ -1,10 +1,7 @@
+import type { IsBase32Options } from '../types'
 import assertString from './util/assertString'
 import merge from './util/merge'
 
-export interface IsBase32Options {
-  crockford?: boolean | string
-}
-
 const base32 = /^[A-Z2-7]+=*$/
 const crockfordBase32 = /^[A-HJKMNP-TV-Z0-9]+$/
 
diff --git a/src/lib/isBase64.ts b/src/lib/isBase64.ts
@@ -1,11 +1,7 @@
+import type { IsBase64Options } from '../types'
 import assertString from './util/assertString'
 import merge from './util/merge'
 
-export interface IsBase64Options {
-  urlSafe?: boolean | string
-  padding?: boolean | string
-}
-
 const base64WithPadding = /^(?:[A-Z0-9+/]{4})*(?:[A-Z0-9+/]{2}==|[A-Z0-9+/]{3}=|[A-Z0-9+/]{4})$/i
 const base64WithoutPadding = /^[A-Z0-9+/]+$/i
 const base64UrlWithPadding = /^(?:[\w-]{4})*(?:[\w-]{2}==|[\w-]{3}=|[\w-]{4})$/
diff --git a/src/lib/isBefore.ts b/src/lib/isBefore.ts
@@ -1,9 +1,6 @@
+import type { IsBeforeOptions } from '../types'
 import toDate from './toDate'
 
-export interface IsBeforeOptions {
-  comparisonDate?: string | number | Date
-}
-
 /**
  * Check if the string is Before
  *
diff --git a/src/lib/isBoolean.ts b/src/lib/isBoolean.ts
@@ -1,10 +1,7 @@
+import type { IsBooleanOptions } from '../types'
 import assertString from './util/assertString'
 import includes from './util/includesArray'
 
-export interface IsBooleanOptions {
-  loose?: boolean
-}
-
 const defaultOptions: IsBooleanOptions = { loose: false }
 const strictBooleans = ['true', 'false', '1', '0']
 const looseBooleans = [...strictBooleans, 'yes', 'no']
diff --git a/src/lib/isByteLength.ts b/src/lib/isByteLength.ts
@@ -1,10 +1,6 @@
+import type { IsByteLengthOptions } from '../types'
 import assertString from './util/assertString'
 
-export interface IsByteLengthOptions {
-  min?: number
-  max?: number
-}
-
 /* eslint-disable prefer-rest-params */
 /**
  * Check if the string is ByteLength
diff --git a/src/lib/isCreditCard.ts b/src/lib/isCreditCard.ts
@@ -1,3 +1,4 @@
+import type { CreditCardOptions } from '../types'
 import isLuhnValid from './isLuhnNumber'
 import assertString from './util/assertString'
 
@@ -22,10 +23,6 @@ const allCards = (() => {
   return tmpCardsArray
 })()
 
-interface CreditCardOptions {
-  provider?: string
-}
-
 /**
  * Check if the string is CreditCard
  *
diff --git a/src/lib/isCurrency.ts b/src/lib/isCurrency.ts
@@ -1,3 +1,4 @@
+import type { CurrencyOptions } from '../types'
 import assertString from './util/assertString'
 import merge from './util/merge'
 
@@ -64,24 +65,6 @@ function currencyRegex(options: CurrencyOptions): RegExp {
   return new RegExp(`^(?!-? )(?=.*\\d)${pattern}$`)
 }
 
-interface CurrencyOptions {
-  symbol: string
-  require_symbol: boolean
-  allow_space_after_symbol: boolean
-  symbol_after_digits: boolean
-  allow_negatives: boolean
-  parens_for_negatives: boolean
-  negative_sign_before_digits: boolean
-  negative_sign_after_digits: boolean
-  allow_negative_sign_placeholder: boolean
-  thousands_separator: string
-  decimal_separator: string
-  allow_decimal: boolean
-  require_decimal: boolean
-  digits_after_decimal: number[]
-  allow_space_after_digits: boolean
-}
-
 const default_currency_options: CurrencyOptions = {
   symbol: '$',
   require_symbol: false,
diff --git a/src/lib/isDate.ts b/src/lib/isDate.ts
@@ -1,17 +1,6 @@
+import type { DateOptions } from '../types'
 import merge from './util/merge'
 
-interface DateOptions {
-  format: string
-  delimiters: string[]
-  strictMode: boolean
-}
-
-interface DateObj {
-  y: string
-  m: string
-  d: string
-}
-
 const default_date_options = {
   format: 'YYYY/MM/DD',
   delimiters: ['/', '-'],
diff --git a/src/lib/isDecimal.ts b/src/lib/isDecimal.ts
@@ -1,14 +1,9 @@
+import type { DecimalOptions } from '../types'
 import { decimal } from './alpha'
 import assertString from './util/assertString'
 import includes from './util/includesArray'
 import merge from './util/merge'
 
-interface DecimalOptions {
-  force_decimal: boolean
-  decimal_digits: string
-  locale: string
-}
-
 function decimalRegExp(options: DecimalOptions): RegExp {
   const regExp = new RegExp(`^[-+]?([0-9]+)?(\\${decimal[options.locale]}[0-9]{${options.decimal_digits}})${options.force_decimal ? '' : '?'}$`)
   return regExp
diff --git a/src/lib/isEmpty.ts b/src/lib/isEmpty.ts
@@ -1,15 +1,6 @@
+import type { IsEmptyOptions } from '../types'
 import assertString from './util/assertString'
 
-/**
- * Options for the isEmpty function
- */
-export interface IsEmptyOptions {
-  /**
-   * Consider spaces as empty
-   */
-  ignoreWhitespace?: boolean
-}
-
 /**
  * Check if the string is empty.
  * @param str The string to check
diff --git a/src/lib/isStrongPassword.ts b/src/lib/isStrongPassword.ts
@@ -76,7 +76,7 @@ function analyzePassword(password: string) {
   return analysis
 }
 
-function scorePassword(analysis: PasswordAnalysis, scoringOptions: any) {
+function scorePassword(analysis: PasswordAnalysis, scoringOptions: typeof defaultOptions) {
   let points = 0
   points += analysis.uniqueChars * scoringOptions.pointsPerUnique
   points += (analysis.length - analysis.uniqueChars) * scoringOptions.pointsPerRepeat
diff --git a/src/lib/isURL.ts b/src/lib/isURL.ts
@@ -7,22 +7,24 @@ import includes from './util/includesString'
 import merge from './util/merge'
 
 export interface IsURLOptions {
-  validate_length?: boolean | string
+  protocols?: string[]
+  require_tld?: boolean
+  require_protocol?: boolean
+  require_host?: boolean
+  require_port?: boolean
+  require_valid_protocol?: boolean
+  allow_underscores?: boolean
+  allow_trailing_dot?: boolean
+  allow_protocol_relative_urls?: boolean
+  allow_fragments?: boolean
+  allow_query_components?: boolean
+  validate_length?: boolean
   max_allowed_length?: number
-  allow_fragments?: boolean | string
-  allow_query_components?: boolean | string
-  require_valid_protocol?: boolean | string
-  protocols?: boolean | string
-  require_protocol?: boolean | string
-  allow_protocol_relative_urls?: boolean | string
-  require_host?: boolean | string
-  disallow_auth?: boolean | string
-  require_port?: boolean | string
-  host_whitelist?: boolean | string
-  host_blacklist?: boolean | string
+  host_whitelist?: (string | RegExp)[]
+  host_blacklist?: (string | RegExp)[]
+  disallow_auth?: boolean
 }
 
-
 /*
 options for isURL method
 
@@ -64,7 +66,7 @@ const default_url_options = {
   allow_fragments: true,
   allow_query_components: true,
   validate_length: true,
-  max_allowed_length: 2084
+  max_allowed_length: 2084,
 }
 
 const wrapped_ipv6 = /^\[([^\]]+)\](?::(\d+))?$/
@@ -76,7 +78,7 @@ const wrapped_ipv6 = /^\[([^\]]+)\](?::(\d+))?$/
  * @param options - Options object
  * @returns True if the string matches the validation, false otherwise
  */
-export default function isURL(url: string, options: any) {
+export default function isURL(url: string, options?: Partial<IsURLOptions>) {
   assertString(url)
   if (!url || /[\s<>]/.test(url)) {
     return false
@@ -86,7 +88,7 @@ export default function isURL(url: string, options: any) {
   }
   options = merge(options, default_url_options)
 
-  if (options.validate_length && url.length > options.max_allowed_length) {
+  if (options?.validate_length && url.length > (options?.max_allowed_length ?? default_url_options.max_allowed_length)) {
     return false
   }
 
@@ -98,7 +100,9 @@ export default function isURL(url: string, options: any) {
     return false
   }
 
-  let protocol, auth, host, hostname, port, port_str, split, ipv6
+  let protocol, auth, host, port, port_str, split, ipv6
+
+  const hostname = split.join('@')
 
   split = url.split('#')
   url = split.shift()
@@ -109,7 +113,7 @@ export default function isURL(url: string, options: any) {
   split = url.split('://')
   if (split.length > 1) {
     protocol = split.shift().toLowerCase()
-    if (options.require_valid_protocol && !options.protocols.includes(protocol)) {
+    if (options?.require_valid_protocol && !(options?.protocols ?? default_url_options.protocols).includes(protocol)) {
       return false
     }
   }
@@ -152,7 +156,6 @@ export default function isURL(url: string, options: any) {
       return false
     }
   }
-  hostname = split.join('@')
 
   port_str = null
   ipv6 = null
@@ -188,7 +191,7 @@ export default function isURL(url: string, options: any) {
     return true
   }
 
-  if (!isIP(host) && !isFQDN(host, options) && (!ipv6 || !isIP(ipv6, 6))) {
+  if (!isIP(host) && !isFQDN(host, options) && (!ipv6 || !isIP(ipv6, { version: 6 }))) {
     return false
   }
 
diff --git a/src/lib/isUUID.ts b/src/lib/isUUID.ts
@@ -15,7 +15,7 @@ const uuid = {
   loose: /^[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/i,
 
   // From https://github.com/uuidjs/uuid/blob/main/src/regex.js
-  all: /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/i
+  all: /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/i,
 }
 
 /**
@@ -25,7 +25,7 @@ const uuid = {
  * @param version - Options object
  * @returns True if the string matches the validation, false otherwise
  */
-export default function isUUID(str: string, version: any) {
+export default function isUUID(str: string, version?: string): boolean {
   assertString(str)
 
   if (version === undefined || version === null) {
diff --git a/src/lib/isVAT.ts b/src/lib/isVAT.ts
@@ -126,10 +126,10 @@ export const vatMatchers = {
   PE: str => /^(PE)?\d{11}$/.test(str),
   DO: str => /^(DO)?(\d{11}|(\d{3}-\d{7}-\d)|[1,45]\d{8}|([1,45])-\d{2}-\d{5}-\d)$/.test(str),
   UY: str => /^(UY)?\d{12}$/.test(str),
-  VE: str => /^(VE)?[J,GVE]-(\d{9}|(\d{8}-\d))$/.test(str)
+  VE: str => /^(VE)?[J,GVE]-(\d{9}|(\d{8}-\d))$/.test(str),
 }
 
-export default function isVAT(str: string, countryCode: any) {
+export default function isVAT(str: string, countryCode: string): boolean {
   assertString(str)
   assertString(countryCode)
 
diff --git a/src/lib/isVariableWidth.ts b/src/lib/isVariableWidth.ts
@@ -9,7 +9,7 @@ import assertString from './util/assertString'
  * @param str - The string to check
  * @returns True if the string matches the validation, false otherwise
  */
-export default function isVariableWidth(str: string) {
+export default function isVariableWidth(str: string): boolean {
   assertString(str)
   return fullWidth.test(str) && halfWidth.test(str)
 }
diff --git a/src/lib/isWhitelisted.ts b/src/lib/isWhitelisted.ts
@@ -7,9 +7,9 @@ import assertString from './util/assertString'
  * @param chars - Options object
  * @returns True if the string matches the validation, false otherwise
  */
-export default function isWhitelisted(str: string, chars: any) {
+export default function isWhitelisted(str: string, chars: string[]): boolean {
   assertString(str)
-  for (let i = str.length - 1 i >= 0 i--) {
+  for (let i = str.length - 1; i >= 0; i--) {
     if (!chars.includes(str[i])) {
       return false
     }
diff --git a/src/lib/ltrim.ts b/src/lib/ltrim.ts
@@ -7,7 +7,7 @@ import assertString from './util/assertString'
  * @param chars - Options object
  * @returns The processed string
  */
-export default function ltrim(str: string, chars: any) {
+export default function ltrim(str: string, chars: string): string {
   assertString(str)
   // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Escaping
   const pattern = chars ? new RegExp(`^[${chars.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}]+`, 'g') : /^\s+/g
diff --git a/src/lib/matches.ts b/src/lib/matches.ts
diff --git a/src/lib/normalizeEmail.ts b/src/lib/normalizeEmail.ts
diff --git a/src/lib/rtrim.ts b/src/lib/rtrim.ts
diff --git a/src/lib/trim.ts b/src/lib/trim.ts
diff --git a/src/lib/types.ts b/src/lib/types.ts
diff --git a/src/lib/unescape.ts b/src/lib/unescape.ts
diff --git a/src/lib/whitelist.ts b/src/lib/whitelist.ts
diff --git a/src/types.ts b/src/types.ts
