@freenotes/web-runtime

---

@freenotes/web-runtime / HttpEndpointDefinition

Interface: HttpEndpointDefinition

Defined in: src/http/types.ts:130

Properties

data?

readonly optional data?: ApiContract<unknown>

Defined in: src/http/types.ts:131

---

decodeResponse?

readonly optional decodeResponse?: false | HttpResponseDecoder

Defined in: src/http/types.ts:146

---

headers?

readonly optional headers?: Readonly<HttpHeaders>

Defined in: src/http/types.ts:132

---

method

readonly method: HttpMethod

Defined in: src/http/types.ts:133

---

path?

readonly optional path?: ApiContract<object>

Defined in: src/http/types.ts:134

---

query?

readonly optional query?: ApiContract<object>

Defined in: src/http/types.ts:135

---

response?

readonly optional response?: ApiContract<unknown>

Defined in: src/http/types.ts:136

---

responseType?

readonly optional responseType?: HttpResponseType

Defined in: src/http/types.ts:137

---

timeoutMs?

readonly optional timeoutMs?: number

Defined in: src/http/types.ts:138

---

transformRequest?

readonly optional transformRequest?: (context) => MaybePromise<void | HttpEndpointRequestOverrides>

Defined in: src/http/types.ts:139

Parameters

context

HttpRequestContext

Returns

MaybePromise<void | HttpEndpointRequestOverrides>

---

transformResponse?

readonly optional transformResponse?: (value, context) => unknown

Defined in: src/http/types.ts:142

Parameters

value

unknown

context

HttpRequestContext

Returns

unknown

---

url

readonly url: string

Defined in: src/http/types.ts:147