Skip to main content

Interface: StringPayloadValidationOptions

Defined in: electron/services/ipc/validators/utils/stringPayloadValidation.ts:24

Internal

Options for validating a required string payload with a byte budget.

Properties​

maxBytes​

readonly maxBytes: number;

Defined in: electron/services/ipc/validators/utils/stringPayloadValidation.ts:26

Maximum allowed UTF-8 byte length for the payload.

maxBytesMessage​

readonly maxBytesMessage: string;

Defined in: electron/services/ipc/validators/utils/stringPayloadValidation.ts:28

Error message when the payload exceeds the byte budget.

paramName​

readonly paramName: string;

Defined in: electron/services/ipc/validators/utils/stringPayloadValidation.ts:30

The IPC parameter name used in error messages.

stringTypeMessage?​

readonly optional stringTypeMessage?: string;

Defined in: electron/services/ipc/validators/utils/stringPayloadValidation.ts:32

Optional override for the "must be a string" error message.