Class Trait<TConfig>Abstract

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.

Type Parameters

Hierarchy

Constructors

constructor

Properties

_config? _global _type?

Methods

hookIntoSchema hookIntoSchemaManager makeGlobal name process setConfig traitConfig wrapLegacyResolver traitTypeName

Constructors

constructor

  • Type Parameters

    Returns Trait<TConfig>

Properties

Protected Optional _config

_config?: TConfig

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?: ExtractTraitConfigType<TConfig>

Trait type.

Methods

hookIntoSchema

hookIntoSchemaManager

  • Attaches Trait callbacks to schema manager hooks.

    Returns void

makeGlobal

name

process

  • 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>

setConfig

  • Configuration setter.

    Parameters

    • config: TConfig

      The new configuration.

    Returns void

traitConfig

wrapLegacyResolver

Static traitTypeName

  • This method should return the trait machine name(s).

    Returns

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc