Skip to main content

Function: validateUrlStringCandidate()

validateUrlStringCandidate(rawUrl: unknown, options: ValidateUrlStringCandidateOptions): UrlStringCandidateValidationResult

Defined in: shared/utils/urlCandidateValidation.ts:56

Validates primitive URL-string constraints shared across URL safety helpers.

Parametersโ€‹

rawUrlโ€‹

unknown

optionsโ€‹

ValidateUrlStringCandidateOptions

Returnsโ€‹

UrlStringCandidateValidationResult

Remarksโ€‹

This helper deliberately does not enforce protocol or domain policies. It only standardizes common trust-boundary checks used by multiple higher-level validators:

  • Candidate must be a string
  • Trim surrounding whitespace
  • Enforce non-empty value
  • Enforce UTF-8 byte budget
  • Reject CR/LF and ASCII control characters

Returning a safeUrlForLogging for both success and failure keeps caller error handling consistent and avoids accidental raw URL logging.