Skip to main content

Function: validateServicePayload()

validateServicePayload<T>(validator: Validator<T>, value: unknown, context: ValidationContext): T

Defined in: src/services/utils/validation.ts:146

Validates a payload using a shared Zod schema and unwraps the typed result.

Type Parameters​

T​

T

Parameters​

validator​

Validator<T>

Function returning a safeParse-style result.

value​

unknown

Raw value to validate.

context​

ValidationContext

Service/operation context used to format errors.

Returns​

T

Parsed data when validation succeeds.

Remarks​

This helper is intentionally opinionated about the resulting error messages, following the pattern used by data-oriented services:

  • When the validator throws, the error message uses the form:

    • "[ServiceName] <operation> threw during validation".

  • When validation fails, the message uses the form:

    • "[ServiceName] <operation> returned invalid payload: <issues>".

In both cases, the original error (validator exception or Zod error) is attached via https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error.cause. Callers are expected to allow these errors to propagate into the existing service wrappers (for example getIpcServiceHelpers().wrap()), which handle logging and error surfacing.

Throws​

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error when validation fails or the validator itself throws.