Skip to main content

sanitizeInput

API Docs

Function: sanitizeInput()

Call Signature​

sanitizeInput(str): SanitizedInputString

Defined in: src/utilities/sanitizer.ts:55

Sanitizes user input by trimming whitespace and normalizing the string. This is for INPUT normalization, not OUTPUT escaping.

Parameters​

str​

string

The string to sanitize.

Returns​

SanitizedInputString

  • The sanitized (trimmed) string with branded type.

Call Signature​

sanitizeInput(str): SanitizedInputString | null

Defined in: src/utilities/sanitizer.ts:56

Sanitizes user input by trimming whitespace and normalizing the string. This is for INPUT normalization, not OUTPUT escaping.

Parameters​

str​

The string to sanitize.

string | null

Returns​

SanitizedInputString | null

  • The sanitized (trimmed) string with branded type.

Call Signature​

sanitizeInput(str): SanitizedInputString | undefined

Defined in: src/utilities/sanitizer.ts:57

Sanitizes user input by trimming whitespace and normalizing the string. This is for INPUT normalization, not OUTPUT escaping.

Parameters​

str​

The string to sanitize.

string | undefined

Returns​

SanitizedInputString | undefined

  • The sanitized (trimmed) string with branded type.

Call Signature​

sanitizeInput(str): SanitizedInputString | null | undefined

Defined in: src/utilities/sanitizer.ts:60

Sanitizes user input by trimming whitespace and normalizing the string. This is for INPUT normalization, not OUTPUT escaping.

Parameters​

str​

The string to sanitize.

string | null | undefined

Returns​

SanitizedInputString | null | undefined

  • The sanitized (trimmed) string with branded type.