Interface ProtoHttpConfig<RequestType, ResponseType>

Main configuration object. Describes serialization, deserialization

RequestType is supposed to be YourProtoRequestMessage.AsObject. ResponseType is supposed to be YourProtoResponseMessage.AsObject.

Type Parameters

RequestType
ResponseType

Hierarchy

ProtoHttpConfig

Index

Properties

versionHeader

Methods

Properties

Optional versionHeader

versionHeader?: { name: string; value: string }

If provided, will be used by VersionInterceptor

Type declaration

name: string
value: string

Methods

deserializer

deserializer(response: ArrayBuffer): ResponseType

- Defined in angular-packages/projects/ngx-customapp-proto-http/src/lib/models/proto-http-config.ts:18
Function to be called on every response.

Parameters
- response: ArrayBuffer
  
  serialized protobuf response.
Returns ResponseType

Optional isErrorResponse

isErrorResponse(response: ResponseType): boolean

- Defined in angular-packages/projects/ngx-customapp-proto-http/src/lib/models/proto-http-config.ts:24
It's expected, that error might be sent as a regular response, so you could this function to detect. If a regular response is determined as an error, RequestService.request will error with that response.

Parameters
- response: ResponseType
  
  deserialized proto message.
Returns boolean

serializer

serializer(request: RequestType): ArrayBuffer

- Defined in angular-packages/projects/ngx-customapp-proto-http/src/lib/models/proto-http-config.ts:12
Function to be called on every request.

Parameters
- request: RequestType
  
  A message to be serialized into UnderlyingDataType
Returns ArrayBuffer

Generated using TypeDoc