OperationIdTransportParameters
Class: OperationIdTransportParameters
Defined in: packages/core/src/rest/operationstransport.service.ts:12
Parameters of the operation-id transport
Extends
Constructors
Constructor
new OperationIdTransportParameters():
OperationIdTransportParameters
Returns
OperationIdTransportParameters
Inherited from
OperationsTransportParameters.constructor
Properties
cli?
optionalcli?:object
Defined in: packages/core/src/rest/operationstransport.service.ts:25
CLI requirements advertised in the operations listing; update behavior remains a client setting
download_url?
optionaldownload_url?:string
Release download base URL; the CLI defaults to the official GitHub releases when omitted
version_range?
optionalversion_range?:string
Semver constraint the Webda CLI must satisfy, for example ">=1.4.0"
operations?
optionaloperations?:string[]
Defined in: packages/core/src/services/operationstransport.ts:33
List of operations to include/exclude Supports wildcards and negation: ["*", "!User.Delete"]
Default
["*"]
Inherited from
OperationsTransportParameters.operations
streamKeepAliveInterval?
optionalstreamKeepAliveInterval?:number
Defined in: packages/core/src/rest/operationstransport.service.ts:22
Keep-alive interval of a streamed response, in ms
Default
20000
type
type:
string
Defined in: packages/core/src/services/serviceparameters.ts:10
Type of the service
Inherited from
OperationsTransportParameters.type
url
url:
string
Defined in: packages/core/src/rest/operationstransport.service.ts:17
Route prefix
Default
"/operations"
Methods
isIncluded()
isIncluded(
operationId):boolean
Defined in: packages/core/src/services/operationstransport.ts:76
Check if an operation is included by this transport
Parameters
operationId
string
the operation identifier
Returns
boolean
true if the operation is included
Inherited from
OperationsTransportParameters.isIncluded
load()
load(
params?):this
Defined in: packages/core/src/rest/operationstransport.service.ts:33
Parameters
params?
any = {}
Returns
this
Overrides
OperationsTransportParameters.load
update()
update(
params?,delta):this
Defined in: packages/core/src/application/parameters.ts:33
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
OperationsTransportParameters.update
with()
with(
callback):this
Defined in: packages/core/src/application/parameters.ts:63
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