Class ImmutableTrait

The Immutable Trait is used to Stop properties of a schema vertex from being updated after being created. A check is made at the preUpdate Stage.

Usage:

traits:
 - type: immutable
    properties:
      - email
      - username

Hierarchy

Trait<ImmutableTraitConfig>
- ImmutableTrait

Index

Constructors

constructor

new ImmutableTrait(_graphqlSchemaManager: GraphQLSchemaManager, _dataSourceWrapper: DataSourceWrapper): ImmutableTrait
ImmutableTrait Constructor
Parameters
- _graphqlSchemaManager: GraphQLSchemaManager
- _dataSourceWrapper: DataSourceWrapper
Returns ImmutableTrait
Overrides Trait.constructor
- Defined in src/traits/ImmutableTrait.ts:45

Properties

`Protected` `Optional` _config

_config?: ImmutableTraitConfig

Trait instance configuration.

`Protected` `Readonly` _dataSourceWrapper

_dataSourceWrapper: DataSourceWrapper

`Protected` _global

_global: boolean = false

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

`Protected` `Readonly` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

`Protected` `Optional` _type

_type?: "immutable"

Trait type.

Methods

checkImmutable

checkImmutable(dataSourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: any): Promise<void>
Takes the stored data and updated data and checks whether any changed properties are immutable Throws an error if an immutable property is changed
Parameters
- dataSourceWrapper: DataSourceWrapper
  
  dataSourceWrapper Object
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
  
  requires context for user permissions
- item: any
  
  Contains variables used in query
Returns Promise<void>
- Defined in src/traits/ImmutableTrait.ts:97

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/ImmutableTrait.ts:121

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(): ImmutableTrait
Makes this Trait instance global.

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

name

name(): string
Used to return the name.

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

preUpdate

preUpdate(...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
Parameters
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/ImmutableTrait.ts:81

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: ImmutableTraitConfig): void
Configuration setter.
Parameters
- config: ImmutableTraitConfig
  
  The new configuration.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/ImmutableTrait.ts:57

traitConfig

traitConfig(): ImmutableTraitConfig
Returns ImmutableTraitConfig
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/ImmutableTrait.ts:71

Class ImmutableTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_graphqlSchemaManager: GraphQLSchemaManager

_dataSourceWrapper: DataSourceWrapper

Returns ImmutableTrait

Properties

Protected Optional _config

Protected Readonly _dataSourceWrapper

Protected _global

Protected Readonly _graphqlSchemaManager

Protected Optional _type

Methods

checkImmutable

Parameters

dataSourceWrapper: DataSourceWrapper

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

item: any

Returns Promise<void>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns ImmutableTrait

name

Returns string

preUpdate

Parameters

Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]

Returns Promise<void>

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

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

Returns Promise<RT>

setConfig

Parameters

config: ImmutableTraitConfig

Returns void

traitConfig

Returns ImmutableTraitConfig

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` `Readonly` _dataSourceWrapper

`Protected` _global

`Protected` `Readonly` _graphqlSchemaManager

`Protected` `Optional` _type

`Rest` ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]

`Optional` callbackName: string

`Static` traitTypeName