@serenity-is/corelib / RetrieveResponse

Interface: RetrieveResponse<TEntity>

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

Response DTO for Retrieve handlers.

Extends

• ServiceResponse

Type Parameters

TEntity

TEntity

Row / entity type.

Properties

Entity?

optional Entity: TEntity

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

The retrieved entity, or undefined if not found (depending on handler).

---

Error?

optional Error: ServiceError

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

Error information when the request failed; undefined on success.

Inherited from

ServiceResponse.Error

---

Localizations?

optional Localizations: object

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

Per-language values for localizable fields, keyed by language ID.

Index Signature

[languageId: string]: Partial<TEntity>