Skip to main content

OperationsTransportParameters

@webda/core

Class: OperationsTransportParameters

Defined in: packages/core/src/services/operationstransport.ts:10

Parameters for transports that selectively expose operations based on include/exclude patterns

Extends​

Extended by​

Constructors​

Constructor​

new OperationsTransportParameters(): OperationsTransportParameters

Returns​

OperationsTransportParameters

Inherited from​

ServiceParameters.constructor

Properties​

operations?​

optional operations?: string[]

Defined in: packages/core/src/services/operationstransport.ts:16

List of operations to include/exclude Supports wildcards and negation: ["*", "!User.Delete"]

Default​

["*"]

type​

type: string

Defined in: packages/core/src/services/serviceparameters.ts:10

Type of the service

Inherited from​

ServiceParameters.type

Methods​

isIncluded()​

isIncluded(operationId): boolean

Defined in: packages/core/src/services/operationstransport.ts:63

Check if an operation is included by this transport

Parameters​

operationId​

string

the operation identifier

Returns​

boolean

true if the operation is included

load()​

load(params?): this

Defined in: packages/core/src/services/operationstransport.ts:29

Load parameters and parse the include/exclude lists

Parameters​

params?​

any = {}

the service parameters

Returns​

this

this for chaining

Overrides​

ServiceParameters.load

update()​

update(params?, delta): this

Defined in: packages/core/src/services/serviceparameters.ts:35

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/src/services/serviceparameters.ts:65

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