Skip to main content

SdkGeneratorParameters

@webda/sdk

Class: SdkGeneratorParameters

Defined in: sdk/src/sdkgenerator.service.ts:13

Parameters of the SDK generator

Extends​

  • ServiceParameters

Constructors​

Constructor​

new SdkGeneratorParameters(): SdkGeneratorParameters

Returns​

SdkGeneratorParameters

Inherited from​

ServiceParameters.constructor

Properties​

exclude?​

optional exclude?: string[]

Defined in: sdk/src/sdkgenerator.service.ts:27

Operation id globs to exclude (*.Delete)

include?​

optional include?: string[]

Defined in: sdk/src/sdkgenerator.service.ts:23

Operation id globs to include (Task.*, Tasks.Query, Auth.*)

Default​

every operation

models​

models: boolean

Defined in: sdk/src/sdkgenerator.service.ts:32

Emit models.ts and the model clients

Default​

true

offline?​

optional offline?: boolean

Defined in: sdk/src/sdkgenerator.service.ts:51

Describe the SyncService in the manifest

Default​

true when one is configured

outDir​

outDir: string

Defined in: sdk/src/sdkgenerator.service.ts:18

Folder the SDK is written to, relative to the application

Default​

".webda/sdk"

package?​

optional package?: object

Defined in: sdk/src/sdkgenerator.service.ts:36

Write a package.json so the folder is a workspace package

name​

name: string

version?​

optional version?: string

sharedImports​

sharedImports: string[]

Defined in: sdk/src/sdkgenerator.service.ts:41

Modules a @Shared method may import from (also read by the compiler)

Default​

["@webda/utils", "@webda/ql"]

transports?​

optional transports?: ("rest" | "graphql" | "grpc")[]

Defined in: sdk/src/sdkgenerator.service.ts:46

Exposures to describe in the manifest

Default​

every configured transport service

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

types?​

optional types?: Record<string, unknown>

Defined in: sdk/src/sdkgenerator.service.ts:55

json-schema-to-typescript options passthrough

Methods​

load()​

load(params?): this

Defined in: sdk/src/sdkgenerator.service.ts:61

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this with the defaults

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

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: core/lib/application/parameters.d.ts:27

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