@serenity-is/corelib / ListResponse

Interface: ListResponse<TEntity>

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

Response DTO for List handlers.

Extends

• ServiceResponse

Type Parameters

TEntity

TEntity

Row / entity type of the listed records.

Properties

Entities?

optional Entities: TEntity[]

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

Page of entities matching the request.

---

Error?

optional Error: ServiceError

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

Error information when the request failed; undefined on success.

Inherited from

ServiceResponse.Error

---

More?

optional More: boolean

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

Whether more records are available beyond the returned page, when requested.

---

Skip?

optional Skip: number

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

Echo of Skip from the request.

---

Take?

optional Take: number

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

Echo of Take from the request.

---

TotalCount?

optional TotalCount: number

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

Total number of records matching the filter (before paging), unless ExcludeTotalCount was set.

---

Values?

optional Values: any[]

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

Alternative Values array used by some handlers that return raw values instead of entities.