Skip to main content

DomainServiceParameters

@webda/core • Readme | API


Class: DomainServiceParameters

Interface to specify the Service parameters

Extends​

Constructors​

new DomainServiceParameters(params)​

new DomainServiceParameters(params): DomainServiceParameters

Parameters​

• params: DeepPartial<DomainServiceParameters>

Returns​

DomainServiceParameters

Overrides​

ServiceParameters.constructor

Source​

packages/core/src/services/domainservice.ts:181

Properties​

models​

models: string[]

List of models to include

If model is prefixed with a ! it will be excluded

Default​

["*"]

Source​

packages/core/src/services/domainservice.ts:174


nameTransfomer​

nameTransfomer: TransformCaseType

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

See​

https://blog.boot.dev/clean-code/casings-in-coding/#:~:text=%F0%9F%94%97%20Camel%20Case,Go

Source​

packages/core/src/services/domainservice.ts:160


openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

ServiceParameters.openapi

Source​

packages/core/src/services/service.ts:260


operations​

operations: boolean

Expose objects as operations too

Source​

packages/core/src/services/domainservice.ts:154


queryMethod​

queryMethod: "GET" | "PUT"

Method used for query objects

Default​

"PUT"

Source​

packages/core/src/services/domainservice.ts:166


type​

type: string

Type of the service

Inherited from​

ServiceParameters.type

Source​

packages/core/src/services/service.ts:251


url?​

url?: string

URL on which to serve the content

Inherited from​

ServiceParameters.url

Source​

packages/core/src/services/service.ts:255

Methods​

isExcluded()​

isExcluded(model): boolean

Is a model excluded from the service

Parameters​

• model: string

Returns​

boolean

Source​

packages/core/src/services/domainservice.ts:209


isIncluded()​

isIncluded(model): boolean

Is a model is included in the service

Parameters​

• model: string

Returns​

boolean

Source​

packages/core/src/services/domainservice.ts:200