Skip to main content

ProxyParameters

@webda/runtime


Class: ProxyParameters

Defined in: packages/runtime/src/services/proxy.service.ts:49

Proxy to a backend service

Extends​

  • ServiceParameters

Constructors​

Constructor​

new ProxyParameters(params?): ProxyParameters

Defined in: packages/runtime/src/services/proxy.service.ts:73

Normalize backend URL and set defaults

Parameters​

params?​

any

raw configuration values

Returns​

ProxyParameters

Overrides​

ServiceParameters.constructor

Properties​

backend​

backend: string

Defined in: packages/runtime/src/services/proxy.service.ts:57

URL to proxy to


proxyHeaders​

proxyHeaders: boolean

Defined in: packages/runtime/src/services/proxy.service.ts:67

Add X-Forwarded-* headers

Default​

true

requireAuthentication​

requireAuthentication: boolean

Defined in: packages/runtime/src/services/proxy.service.ts:61

Helper to refuse any request if user is not auth


type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type


url?​

optional url?: string

Defined in: packages/runtime/src/services/proxy.service.ts:53

URL to expose

Methods​

load()​

load(params?): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:18

Load raw parameters by assigning them onto this instance

Parameters​

params?​

any

the service parameters

Returns​

this

this for chaining

Inherited from​

ServiceParameters.load


update()​

update(params, delta): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update


with()​

with(callback): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with