Skip to main content

GraphQLParameters

@webda/graphql

Class: GraphQLParameters

Defined in: graphql/src/graphql.service.ts:139

Parameters for the GraphQL service

Extends​

  • DomainServiceParameters

Constructors​

Constructor​

new GraphQLParameters(): GraphQLParameters

Returns​

GraphQLParameters

Inherited from​

DomainServiceParameters.constructor

Properties​

exposeGraphiQL​

exposeGraphiQL: boolean

Defined in: graphql/src/graphql.service.ts:164

Expose the schema

exposeMe​

exposeMe: boolean

Defined in: graphql/src/graphql.service.ts:160

Expose current user in the context with me

Default​

true

globalSubscription​

globalSubscription: boolean

Defined in: graphql/src/graphql.service.ts:168

Expose a aggregation of all available subscriptions

maxOperationsPerRequest​

maxOperationsPerRequest: number

Defined in: graphql/src/graphql.service.ts:150

Max number of requests allowed within a graphql query or mutation

Default​

10

models?​

optional models?: string[]

Defined in: core/lib/services/domainservice.service.d.ts:96

List of models to include

If model is prefixed with a ! it will be excluded

Default​

["*"]

Inherited from​

DomainServiceParameters.models

nameTransfomer?​

optional nameTransfomer?: TransformCaseType

Defined in: core/lib/services/domainservice.service.d.ts:82

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

Default​

camelCase

Inherited from​

DomainServiceParameters.nameTransfomer

operations?​

optional operations?: boolean

Defined in: core/lib/services/domainservice.service.d.ts:75

Expose objects as operations too

Default​

true

Inherited from​

DomainServiceParameters.operations

queryMethod?​

optional queryMethod?: "PUT" | "GET"

Defined in: core/lib/services/domainservice.service.d.ts:88

Method used for query objects

Default​

"PUT"

Inherited from​

DomainServiceParameters.queryMethod

type​

type: string

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

Type of the service

Inherited from​

DomainServiceParameters.type

url​

url: string

Defined in: graphql/src/graphql.service.ts:144

URL for the GraphQL endpoint

Default​

/graphql

userModel​

userModel: string

Defined in: graphql/src/graphql.service.ts:155

User model to expose

Default​

User

Methods​

isExcluded()​

isExcluded(model): boolean

Defined in: core/lib/services/domainservice.service.d.ts:125

Is a model excluded from the service

Parameters​

model​

string

the model to use

Returns​

boolean

the result

Inherited from​

DomainServiceParameters.isExcluded

isExplicitlyIncluded()​

isExplicitlyIncluded(model): boolean

Defined in: core/lib/services/domainservice.service.d.ts:119

Is a model explicitly listed (not through the wildcard) in models

Parameters​

model​

string

the model identifier

Returns​

boolean

the result

Inherited from​

DomainServiceParameters.isExplicitlyIncluded

isIncluded()​

isIncluded(model): boolean

Defined in: core/lib/services/domainservice.service.d.ts:113

Is a model is included in the service

Parameters​

model​

string

the model to use

Returns​

boolean

the result

Inherited from​

DomainServiceParameters.isIncluded

load()​

load(params?): this

Defined in: graphql/src/graphql.service.ts:175

Load parameters with defaults

Parameters​

params?​

any = {}

raw configuration values

Returns​

this

this for chaining

Overrides​

DomainServiceParameters.load

update()​

update(params, delta): this

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

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​

DomainServiceParameters.update

with()​

with(callback): this

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

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​

DomainServiceParameters.with