Skip to main content

RESTOperationsTransportParameters

@webda/core

Class: RESTOperationsTransportParameters

Defined in: packages/core/src/rest/restoperationstransport.service.ts:84

Parameters for RESTOperationsTransport

Extends​

Constructors​

Constructor​

new RESTOperationsTransportParameters(): RESTOperationsTransportParameters

Returns​

RESTOperationsTransportParameters

Inherited from​

OperationsTransportParameters.constructor

Properties​

exposeOpenAPI?​

optional exposeOpenAPI?: boolean

Defined in: packages/core/src/rest/restoperationstransport.service.ts:90

Expose the OpenAPI

Default​

true if debug false otherwise

nameTransformer?​

optional nameTransformer?: TransformCaseType

Defined in: packages/core/src/rest/restoperationstransport.service.ts:111

Transform the name of the model to be used in the URL

See​

https://blog.boot.dev/clean-code/casings-in-coding/

Default​

camelCase

operations?​

optional operations?: string[]

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

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

Default​

["*"]

Inherited from​

OperationsTransportParameters.operations

queryMethod?​

optional queryMethod?: "GET" | "PUT"

Defined in: packages/core/src/rest/restoperationstransport.service.ts:117

Method used for query objects

Default​

"PUT"

streamKeepAliveInterval?​

optional streamKeepAliveInterval?: number

Defined in: packages/core/src/rest/restoperationstransport.service.ts:142

Milliseconds between two keep-alive comments on an open text/event-stream response of a server-streaming operation (0 disables them)

Default​

20000

swaggerVersion​

swaggerVersion: string = "5.31.0"

Defined in: packages/core/src/rest/restoperationstransport.service.ts:100

Swagger version to use

https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui.css https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-bundle.js https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-standalone-preset.js

TODO Add renovatebot regex

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/restoperationstransport.service.ts:104

Base URL for the REST API

webSocketMaxPayload?​

optional webSocketMaxPayload?: number

Defined in: packages/core/src/rest/restoperationstransport.service.ts:123

Largest message (bytes) a client may send on a bidirectional WebSocket operation; a bigger one closes the socket

Default​

1048576

webSocketMaxQueuedBytes?​

optional webSocketMaxQueuedBytes?: number

Defined in: packages/core/src/rest/restoperationstransport.service.ts:135

Most bytes of unconsumed messages a bidirectional operation may have queued; above it the socket closes with 4413

Default​

16777216

webSocketMaxQueuedMessages?​

optional webSocketMaxQueuedMessages?: number

Defined in: packages/core/src/rest/restoperationstransport.service.ts:129

Most unconsumed messages a bidirectional operation may have queued; above it the socket closes with 4413

Default​

1000

Methods​

isIncluded()​

isIncluded(operationId): boolean

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

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/restoperationstransport.service.ts:149

Load parameters with defaults

Parameters​

params?​

any = {}

the service parameters

Returns​

this

this for chaining

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

Inherited from​

OperationsTransportParameters.with