Interface: ServiceError

Error payload returned by Serenity service endpoints inside a ServiceResponse. The server populates at least Code or Message; other fields are optional and depend on the handler / validation layer.

Properties

Arguments?

optional Arguments: string

Defined in: src/base/servicetypes.ts:10

Optional comma-separated or serialized arguments that parameterize the error message (e.g. field names).

Code?

optional Code: string

Defined in: src/base/servicetypes.ts:8

Machine-readable error code (e.g. "NotLoggedIn", "ValidationError", "AccessDenied").

Details?

optional Details: string

Defined in: src/base/servicetypes.ts:14

Detailed / technical information (e.g. stack trace or inner exception) — only when diagnostics are enabled.

ErrorId?

optional ErrorId: string

Defined in: src/base/servicetypes.ts:16

Correlation / error ID assigned server-side for log lookup.

Message?

optional Message: string

Defined in: src/base/servicetypes.ts:12

Human-readable, possibly localized, error message suitable for display.