Skip to main content

Variable: IpcValidators

const IpcValidators: { optionalString: (value: unknown, paramName: string) => string | null; requiredBoolean: (value: unknown, paramName: string) => string | null; requiredNumber: (value: unknown, paramName: string) => string | null; requiredObject: (value: unknown, paramName: string) => string | null; requiredString: (value: unknown, paramName: string) => string | null; requiredUrl: (value: unknown, paramName: string) => string | null; }

Defined in: electron/services/ipc/utils.ts:220

Standard parameter validation utilities for common IPC operations.

Type Declaration​

optionalString()​

readonly optionalString: (value: unknown, paramName: string) => string | null

Validates an optional string parameter using validator.

Parameters​

value​

unknown

Value to validate

paramName​

string

Parameter name for error messages

Returns​

string | null

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message or null if valid

requiredBoolean()​

readonly requiredBoolean: (value: unknown, paramName: string) => string | null

Validates a required boolean parameter.

Parameters​

value​

unknown

Value to validate

paramName​

string

Parameter name for error messages

Returns​

string | null

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message or null if valid

requiredNumber()​

readonly requiredNumber: (value: unknown, paramName: string) => string | null

Validates a required number parameter.

Parameters​

value​

unknown

Value to validate

paramName​

string

Parameter name for error messages

Returns​

string | null

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message or null if valid

requiredObject()​

readonly requiredObject: (value: unknown, paramName: string) => string | null

Validates a required object parameter.

Parameters​

value​

unknown

Value to validate

paramName​

string

Parameter name for error messages

Returns​

string | null

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message or null if valid

requiredString()​

readonly requiredString: (value: unknown, paramName: string) => string | null

Validates a required string parameter using validator.

Parameters​

value​

unknown

Value to validate

paramName​

string

Parameter name for error messages

Returns​

string | null

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message or null if valid

requiredUrl()​

readonly requiredUrl: (value: unknown, paramName: string) => string | null

Validates a required URL parameter restricted to safe protocols.

Parameters​

value​

unknown

Value to validate

paramName​

string

Parameter name for error messages

Returns​

string | null

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message or null if valid