Interface: FyzDataResponseSuccess<TData>
@flyze/lib-data-store 3.0.0-alpha.55· latestDefined in: projects/lib-data-store/src/lib/flyze-models/fyz-response.model.ts:10
Extends
Section titled “Extends”DataResponseSuccess<TData,Etag>
Type Parameters
Section titled “Type Parameters”TData
Properties
Section titled “Properties”count?
Section titled “count?”
optionalcount:number
Defined in: projects/lib-data-store/src/lib/flyze-models/fyz-response.model.ts:14
data:
TData
Defined in: node_modules/@flyze/lib-db-models/api/api.response.d.ts:49
The data.
Inherited from
Section titled “Inherited from”_dataResponseSuccess.data
etags:
IEtag[]
Defined in: node_modules/@flyze/lib-db-models/api/api.response.d.ts:60
The per-entity ETags for the entities carried in data.
Remarks
Section titled “Remarks”The raw wire form (TEtag = string) has each entry as a single entity-tag in the
format "<kind>:<id>:<hash>". Parse them with parseEtags and type the
response as FyzDataResponse<TData, Etag> (both from @flyze/lib-db-models) to work with
the structured Etag form. A single aggregate hash of these tags is emitted in
the ETag response header.
Inherited from
Section titled “Inherited from”_dataResponseSuccess.etags
message
Section titled “message”message:
string
Defined in: node_modules/@flyze/lib-db-models/api/api.response.d.ts:14
The optional message.
Remarks
Section titled “Remarks”Only populated when ResponseSuccess.success is true.
Inherited from
Section titled “Inherited from”_dataResponseSuccess.message
responseCode
Section titled “responseCode”responseCode:
string
Defined in: node_modules/@flyze/lib-db-models/api/api.response.d.ts:18
The response code. Defaults server-side to ResponseCodes.c_Default.
Inherited from
Section titled “Inherited from”_dataResponseSuccess.responseCode
responseEtag?
Section titled “responseEtag?”
optionalresponseEtag:string
Defined in: projects/lib-data-store/src/lib/flyze-models/fyz-response.model.ts:22
RFC 9110 §8.8.3 response-level entity-tag from the ETag HTTP header.
Opaque validator for the whole response (kept verbatim, incl. any W/
weak prefix). Reserved for future conditional-request caching
(If-None-Match / 304). Undefined when the server sends no ETag
header (or CORS does not expose it).
success
Section titled “success”success:
true
Defined in: node_modules/@flyze/lib-db-models/api/api.response.d.ts:25
Inherited from
Section titled “Inherited from”_dataResponseSuccess.success