Class ManagedUpdatesTrait

The base Trait class.

Any core Kosmos or custom application traits must inherit this class and must declare it's own configuration type extending TraitConfigBase interface.

Hierarchy

Trait<ManagedUpdatesTraitConfig>
- ManagedUpdatesTrait

Index

Constructors

constructor

new ManagedUpdatesTrait(graphqlSchemaManager: GraphQLSchemaManager, updateManager: UpdateManager): ManagedUpdatesTrait
Parameters
- graphqlSchemaManager: GraphQLSchemaManager
- updateManager: UpdateManager
Returns ManagedUpdatesTrait
Overrides Trait.constructor
- Defined in src/traits/ManagedUpdatesTrait.ts:70

Properties

`Protected` `Optional` _config

_config?: ManagedUpdatesTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

Whether this is a global (not bound to any specific schema item) trait instance.

`Protected` `Optional` _type

_type?: "managed_updates"

Trait type.

`Private` `Readonly` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

`Private` `Readonly` updateManager

updateManager: UpdateManager

`Static` `Private` mutationAdded

mutationAdded: boolean = false

Methods

executeUpdate

executeUpdate(source: unknown, args: {}, context: KosmosUserContext<object>, info: GraphQLResolveInfo): Promise<{
    label: string;
    name: string;
    version: string;
    vertex_id: string;
}[]>
Parameters
- source: unknown
- args: {}
- context: KosmosUserContext<object>
- info: GraphQLResolveInfo
Returns Promise<{
    label: string;
    name: string;
    version: string;
    vertex_id: string;
}[]>
- Defined in src/traits/ManagedUpdatesTrait.ts:96

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/ManagedUpdatesTrait.ts:132

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

makeGlobal

makeGlobal(): ManagedUpdatesTrait
Makes this Trait instance global.

Returns ManagedUpdatesTrait
Inherited from Trait.makeGlobal
- Defined in src/traits/Trait.ts:237

mutationSchema

mutationSchema(source: string): string
Parameters
- source: string
Returns string
- Defined in src/traits/ManagedUpdatesTrait.ts:122

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

process

process<RT, Payload>(callbackName: string, datasourceWrapper: DataSourceWrapper, data: TraitDataObject<RT, Payload, Promise<any>>): Promise<RT>
This method is triggered when a trait callback has been activated
Type Parameters
- RT = any
- Payload = any
Parameters
- callbackName: string
  
  This is the name of the callback function to call.
- datasourceWrapper: DataSourceWrapper
  
  References to the Graph Hanlder
- data: TraitDataObject<RT, Payload, Promise<any>>
  
  Request data passed along as part of the request.
Returns Promise<RT>
Inherited from Trait.process
- Defined in src/traits/Trait.ts:147

setConfig

setConfig(config: ManagedUpdatesTraitConfig): void
Configuration setter.
Parameters
- config: ManagedUpdatesTraitConfig
  
  The new configuration.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/ManagedUpdatesTrait.ts:79

traitConfig

traitConfig(): ManagedUpdatesTraitConfig
Returns ManagedUpdatesTraitConfig
Inherited from Trait.traitConfig
- Defined in src/traits/Trait.ts:205

wrapLegacyResolver

wrapLegacyResolver<RT, Payload>(resolver: LegacyKosmosTraitResolverCallback<RT, any>, datasourceWrapper: DataSourceWrapper, callbackName?: string): KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Helper method for wrapping legacy Kosmos traits callbacks.

TODO: Remove this method once all Traits are converted.
Type Parameters
- RT = any
- Payload = any
Parameters
- resolver: LegacyKosmosTraitResolverCallback<RT, any>
- datasourceWrapper: DataSourceWrapper
- Optional callbackName: string
  
  Optional callback name; passing this parameter will additionally wrap the callback into legacy process().
Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Inherited from Trait.wrapLegacyResolver
- Defined in src/traits/Trait.ts:168

`Static` traitTypeName

traitTypeName(): string
This method should return the trait machine name(s).

Returns

Returns string
Overrides Trait.traitTypeName
- Defined in src/traits/ManagedUpdatesTrait.ts:92

Class ManagedUpdatesTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

updateManager: UpdateManager

Returns ManagedUpdatesTrait

Properties

Protected Optional _config

Protected _global

Protected Optional _type

Private Readonly graphqlSchemaManager

Private Readonly updateManager

Static Private mutationAdded

Methods

executeUpdate

Parameters

source: unknown

args: {}

context: KosmosUserContext<object>

info: GraphQLResolveInfo

Returns Promise<{ label: string; name: string; version: string; vertex_id: string; }[]>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns ManagedUpdatesTrait

mutationSchema

Parameters

source: string

Returns string

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<RT, Payload, Promise<any>>

Returns Promise<RT>

setConfig

Parameters

config: ManagedUpdatesTraitConfig

Returns void

traitConfig

Returns ManagedUpdatesTraitConfig

wrapLegacyResolver

Type Parameters

RT = any

Payload = any

Parameters

resolver: LegacyKosmosTraitResolverCallback<RT, any>

datasourceWrapper: DataSourceWrapper

Optional callbackName: string

Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>

Static traitTypeName

Returns

Returns string

Settings

Member Visibility

Theme

`Protected` `Optional` _config

`Protected` _global

`Protected` `Optional` _type

`Private` `Readonly` graphqlSchemaManager

`Private` `Readonly` updateManager

`Static` `Private` mutationAdded

Returns Promise<{
label: string;
name: string;
version: string;
vertex_id: string;
}[]>

`Optional` callbackName: string

`Static` traitTypeName