Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Trait

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns Trait

Properties

Readonly Abstract key

key: undefined | string

Readonly Abstract model

model: null | Model

Readonly Abstract traitConsumers

traitConsumers: readonly unknown[]

Readonly traitFlags

traitFlags: number

Readonly traitObservers

traitObservers: readonly TraitObserver<Trait>[]

Readonly warpRef

warpRef: ModelProperty<Model, null | WarpRef, never>

Readonly warpService

warpService: TraitService<Trait, WarpManager<Model>>

Static Readonly ConsumingFlag

ConsumingFlag: number

Static Readonly MountedFlag

MountedFlag: number

Static Readonly PoweredFlag

PoweredFlag: number

Static Readonly insertChildFlags

insertChildFlags: number

Static Readonly insertTraitFlags

insertTraitFlags: number

Static Readonly mountFlags

mountFlags: number

Static Readonly powerFlags

powerFlags: number

Static Readonly removeChildFlags

removeChildFlags: number

Static Readonly removeTraitFlags

removeTraitFlags: number

Static Readonly startConsumingFlags

startConsumingFlags: number

Static Readonly stopConsumingFlags

stopConsumingFlags: number

Accessors

childModelCount

  • get childModelCount(): number

  • Returns number

childModels

  • get childModels(): readonly Model[]

  • Returns readonly Model[]

insertChildFlags

  • get insertChildFlags(): number

  • Returns number

insertTraitFlags

  • get insertTraitFlags(): number

  • Returns number

modelContext

modelFlags

  • get modelFlags(): number

  • Returns number

mountFlags

  • get mountFlags(): number

  • Returns number

parentModel

  • get parentModel(): null | Model

  • Returns null | Model

powerFlags

  • get powerFlags(): number

  • Returns number

removeChildFlags

  • get removeChildFlags(): number

  • Returns number

removeTraitFlags

  • get removeTraitFlags(): number

  • Returns number

startConsumingFlags

  • get startConsumingFlags(): number

  • Returns number

stopConsumingFlags

  • get stopConsumingFlags(): number

  • Returns number

traitCount

  • get traitCount(): number

  • Returns number

traits

  • get traits(): readonly Trait[]

  • Returns readonly Trait[]

Methods

Abstract addTraitConsumer

  • addTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

addTraitObserver

  • Parameters

    Returns void

Protected analyzeChildModels

  • analyzeChildModels(analyzeFlags: number, modelContext: ModelContext, analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void, analyzeChildModels: (analyzeFlags: number, modelContext: ModelContext, analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void) => void): void

  • Parameters

    • analyzeFlags: number
    • modelContext: ModelContext
    • analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void
    • analyzeChildModels: (analyzeFlags: number, modelContext: ModelContext, analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void) => void
        • (analyzeFlags: number, modelContext: ModelContext, analyzeChildModel: (childModel: Model, analyzeFlags: number, modelContext: ModelContext) => void): void

        • Parameters

          Returns void

    Returns void

appendChildModel

  • appendChildModel(childModel: Model, key?: string): void

  • Parameters

    • childModel: Model
    • Optional key: string

    Returns void

appendTrait

  • appendTrait(trait: Trait, key?: string): void

  • Parameters

    • trait: Trait
    • Optional key: string

    Returns void

Protected attachParentModel

  • attachParentModel(parentModel: Model): void

  • Parameters

    Returns void

Protected detachParentModel

  • detachParentModel(parentModel: Model): void

  • Parameters

    Returns void

Protected didAddTraitConsumer

  • didAddTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected didAddTraitObserver

  • Parameters

    Returns void

Protected didAggregate

  • Parameters

    Returns void

Protected didAnalyze

  • didAnalyze(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected didAnalyzeChildModel

  • didAnalyzeChildModel(childModel: Model, analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected didAnalyzeChildModels

  • didAnalyzeChildModels(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected didCorrelate

  • Parameters

    Returns void

Protected didInsertChildModel

  • didInsertChildModel(childModel: Model, targetModel: null | Model): void

  • Parameters

    Returns void

Protected didInsertTrait

  • didInsertTrait(trait: Trait, targetTrait: null | Trait): void

  • Parameters

    Returns void

Protected didMount

  • didMount(): void

  • Returns void

Protected didMutate

  • Parameters

    Returns void

Protected didPower

  • didPower(): void

  • Returns void

Protected didReconcile

  • Parameters

    Returns void

Protected didRefresh

  • didRefresh(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected didRefreshChildModel

  • didRefreshChildModel(childModel: Model, refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected didRefreshChildModels

  • didRefreshChildModels(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected didRemoveChildModel

  • didRemoveChildModel(childModel: Model): void

  • Parameters

    Returns void

Protected didRemoveTrait

  • didRemoveTrait(trait: Trait): void

  • Parameters

    Returns void

Protected didRemoveTraitConsumer

  • didRemoveTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected didRemoveTraitObserver

  • Parameters

    Returns void

Protected didRequestUpdate

  • didRequestUpdate(targetModel: Model, updateFlags: number, immediate: boolean): void

  • Parameters

    • targetModel: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

Protected didRequireUpdate

  • didRequireUpdate(updateFlags: number, immediate: boolean): void

  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns void

Protected didSetModel

  • didSetModel(newModel: null | Model, oldModel: null | Model): void

  • Parameters

    Returns void

Protected didSetParentModel

  • didSetParentModel(newParentModel: null | Model, oldParentModel: null | Model): void

  • Parameters

    • newParentModel: null | Model
    • oldParentModel: null | Model

    Returns void

Protected didStartConsuming

  • didStartConsuming(): void

  • Returns void

Protected didStopConsuming

  • didStopConsuming(): void

  • Returns void

Protected didUnmount

  • didUnmount(): void

  • Returns void

Protected didUnpower

  • didUnpower(): void

  • Returns void

Protected didValidate

  • Parameters

    Returns void

Abstract doMount

  • doMount(): void

  • Returns void

Abstract doPower

  • doPower(): void

  • Returns void

Abstract doUnmount

  • doUnmount(): void

  • Returns void

Abstract doUnpower

  • doUnpower(): void

  • Returns void

firstChildModel

  • firstChildModel(): null | Model

  • Returns null | Model

firstTrait

  • firstTrait(): null | Trait

  • Returns null | Trait

forEachChildModel

  • forEachChildModel<T>(callback: (childModel: Model) => void | T): undefined | T
  • forEachChildModel<T, S>(callback: (childModel: Model) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    Parameters

    • callback: (childModel: Model) => void | T
        • (childModel: Model): void | T

        • Parameters

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (childModel: Model) => void | T
        • (childModel: Model): void | T

        • Parameters

          Returns void | T

    • thisArg: S

    Returns undefined | T

forEachTrait

  • forEachTrait<T>(callback: (trait: Trait) => void | T): undefined | T
  • forEachTrait<T, S>(callback: (trait: Trait) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    Parameters

    • callback: (trait: Trait) => void | T
        • (trait: Trait): void | T

        • Parameters

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (trait: Trait) => void | T
        • (trait: Trait): void | T

        • Parameters

          Returns void | T

    • thisArg: S

    Returns undefined | T

getBaseModel

  • getBaseModel<M>(modelClass: ModelClass<M>): null | M

  • Type parameters

    Parameters

    Returns null | M

getBaseTrait

  • getBaseTrait<R>(traitClass: TraitClass<R>): null | R

  • Type parameters

    Parameters

    Returns null | R

getChildModel

  • getChildModel(key: string): null | Model

  • Parameters

    • key: string

    Returns null | Model

getLazyModelDownlink

  • Parameters

    • downlinkName: string

    Returns null | ModelDownlink<Trait>

getLazyTraitFastener

  • Parameters

    • fastenerName: string

    Returns null | TraitFastener<Trait, Trait, never>

getLazyTraitModel

  • Parameters

    • fastenerName: string

    Returns null | TraitModel<Trait, Model, never>

getLazyTraitProperty

  • Parameters

    • propertyName: string

    Returns null | TraitProperty<Trait, unknown, never>

getLazyTraitService

  • Parameters

    • serviceName: string

    Returns null | TraitService<Trait, unknown>

Abstract getModelDownlink

  • Parameters

    • downlinkName: string

    Returns null | ModelDownlink<Trait>

Abstract getModelProperty

  • Parameters

    • propertyName: string

    Returns null | ModelProperty<Model, unknown, never>

getSuperModel

  • getSuperModel<M>(modelClass: ModelClass<M>): null | M

  • Type parameters

    Parameters

    Returns null | M

getSuperTrait

  • getSuperTrait<R>(traitClass: TraitClass<R>): null | R

  • Type parameters

    Parameters

    Returns null | R

getTrait

  • Parameters

    • key: string

    Returns null | Trait

  • Type parameters

    Parameters

    Returns null | R

  • Parameters

    Returns null | Trait

Abstract getTraitFastener

  • Parameters

    • fastenerName: string

    Returns null | TraitFastener<Trait, Trait, never>

Abstract getTraitModel

  • Parameters

    • fastenerName: string

    Returns null | TraitModel<Trait, Model, never>

Abstract getTraitProperty

  • Parameters

    • propertyName: string

    Returns null | TraitProperty<Trait, unknown, never>

Abstract getTraitService

  • Parameters

    • serviceName: string

    Returns null | TraitService<Trait, unknown>

Abstract hasModelDownlink

  • hasModelDownlink(downlinkName: string): boolean

  • Parameters

    • downlinkName: string

    Returns boolean

Abstract hasModelProperty

  • hasModelProperty(propertyName: string): boolean

  • Parameters

    • propertyName: string

    Returns boolean

Abstract hasTraitFastener

  • hasTraitFastener(fastenerName: string): boolean

  • Parameters

    • fastenerName: string

    Returns boolean

Abstract hasTraitModel

  • hasTraitModel(fastenerName: string): boolean

  • Parameters

    • fastenerName: string

    Returns boolean

Abstract hasTraitProperty

  • hasTraitProperty(propertyName: string): boolean

  • Parameters

    • propertyName: string

    Returns boolean

Abstract hasTraitService

  • hasTraitService(serviceName: string): boolean

  • Parameters

    • serviceName: string

    Returns boolean

insertChildModel

  • insertChildModel(childModel: Model, targetModel: null | Model, key?: string): void

  • Parameters

    • childModel: Model
    • targetModel: null | Model
    • Optional key: string

    Returns void

insertTrait

  • insertTrait(trait: Trait, targetTrait: null | Trait, key?: string): void

  • Parameters

    • trait: Trait
    • targetTrait: null | Trait
    • Optional key: string

    Returns void

isAnalyzing

  • isAnalyzing(): boolean

  • Returns boolean

isConsuming

  • isConsuming(): boolean

  • Returns boolean

isMounted

  • isMounted(): boolean

  • Returns boolean

isPowered

  • isPowered(): boolean

  • Returns boolean

isRefreshing

  • isRefreshing(): boolean

  • Returns boolean

isTraversing

  • isTraversing(): boolean

  • Returns boolean

isUpdating

  • isUpdating(): boolean

  • Returns boolean

lastChildModel

  • lastChildModel(): null | Model

  • Returns null | Model

lastTrait

  • lastTrait(): null | Trait

  • Returns null | Trait

needsAnalyze

  • needsAnalyze(analyzeFlags: number, modelContext: ModelContext): number

  • Parameters

    Returns number

needsRefresh

  • needsRefresh(refreshFlags: number, modelContext: ModelContext): number

  • Parameters

    Returns number

nextChildModel

  • nextChildModel(targetModel: Model): null | Model

  • Parameters

    Returns null | Model

nextTrait

  • Parameters

    Returns null | Trait

Protected onAddTraitConsumer

  • onAddTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected onAddTraitObserver

  • Parameters

    Returns void

Protected onAggregate

  • Parameters

    Returns void

Protected onAnalyze

  • onAnalyze(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected onAnalyzeChildModel

  • onAnalyzeChildModel(childModel: Model, analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected onAnalyzeChildModels

  • onAnalyzeChildModels(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected onCorrelate

  • Parameters

    Returns void

Protected onInsertChildModel

  • onInsertChildModel(childModel: Model, targetModel: null | Model): void

  • Parameters

    Returns void

Protected onInsertTrait

  • onInsertTrait(trait: Trait, targetTrait: null | Trait): void

  • Parameters

    Returns void

Protected onMount

  • onMount(): void

  • Returns void

Protected onMutate

  • Parameters

    Returns void

Protected onPower

  • onPower(): void

  • Returns void

Protected onReconcile

  • Parameters

    Returns void

Protected onRefresh

  • onRefresh(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected onRefreshChildModel

  • onRefreshChildModel(childModel: Model, refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected onRefreshChildModels

  • onRefreshChildModels(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected onRemoveChildModel

  • onRemoveChildModel(childModel: Model): void

  • Parameters

    Returns void

Protected onRemoveTrait

  • onRemoveTrait(trait: Trait): void

  • Parameters

    Returns void

Protected onRemoveTraitConsumer

  • onRemoveTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected onRemoveTraitObserver

  • Parameters

    Returns void

Protected onRequestUpdate

  • onRequestUpdate(targetModel: Model, updateFlags: number, immediate: boolean): void

  • Parameters

    • targetModel: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

Protected onRequireUpdate

  • onRequireUpdate(updateFlags: number, immediate: boolean): void

  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns void

Protected onSetModel

  • onSetModel(newModel: null | Model, oldModel: null | Model): void

  • Parameters

    Returns void

Protected onSetParentModel

  • onSetParentModel(newParentModel: null | Model, oldParentModel: null | Model): void

  • Parameters

    • newParentModel: null | Model
    • oldParentModel: null | Model

    Returns void

Protected onStartConsuming

  • onStartConsuming(): void

  • Returns void

Protected onStopConsuming

  • onStopConsuming(): void

  • Returns void

Protected onUnmount

  • onUnmount(): void

  • Returns void

Protected onUnpower

  • onUnpower(): void

  • Returns void

Protected onValidate

  • Parameters

    Returns void

prependChildModel

  • prependChildModel(childModel: Model, key?: string): void

  • Parameters

    • childModel: Model
    • Optional key: string

    Returns void

prependTrait

  • prependTrait(trait: Trait, key?: string): void

  • Parameters

    • trait: Trait
    • Optional key: string

    Returns void

previousChildModel

  • previousChildModel(targetModel: Model): null | Model

  • Parameters

    Returns null | Model

previousTrait

  • Parameters

    Returns null | Trait

Protected refreshChildModels

  • refreshChildModels(refreshFlags: number, modelContext: ModelContext, refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void, refreshChildModels: (refreshFlags: number, modelContext: ModelContext, refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void) => void): void

  • Parameters

    • refreshFlags: number
    • modelContext: ModelContext
    • refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void
    • refreshChildModels: (refreshFlags: number, modelContext: ModelContext, refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void) => void
        • (refreshFlags: number, modelContext: ModelContext, refreshChildModel: (childModel: Model, refreshFlags: number, modelContext: ModelContext) => void): void

        • Parameters

          Returns void

    Returns void

Abstract remove

  • remove(): void

  • Returns void

removeChildModel

  • removeChildModel(key: string): null | Model
  • removeChildModel(childModel: Model): void

  • Parameters

    • key: string

    Returns null | Model

  • Parameters

    Returns void

removeTrait

  • removeTrait(key: string): null | Trait
  • removeTrait(trait: Trait): void

  • Parameters

    • key: string

    Returns null | Trait

  • Parameters

    Returns void

Abstract removeTraitConsumer

  • removeTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

removeTraitObserver

  • Parameters

    Returns void

requestUpdate

  • requestUpdate(targetModel: Model, updateFlags: number, immediate: boolean): void

  • Parameters

    • targetModel: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

requireUpdate

  • requireUpdate(updateFlags: number, immediate?: boolean): void

  • Parameters

    • updateFlags: number
    • Optional immediate: boolean

    Returns void

setChildModel

  • setChildModel(key: string, newChildModel: null | Model): null | Model

  • Parameters

    • key: string
    • newChildModel: null | Model

    Returns null | Model

Abstract setKey

  • setKey(key: undefined | string): void

  • Parameters

    • key: undefined | string

    Returns void

Abstract setModel

  • setModel(newModel: null | Model, oldModel: null | Model): void

  • Parameters

    Returns void

Abstract setModelDownlink

  • setModelDownlink(downlinkName: string, traitDownlink: null | ModelDownlink<Trait>): void

  • Parameters

    Returns void

setModelFlags

  • setModelFlags(modelFlags: number): void

  • Parameters

    • modelFlags: number

    Returns void

Abstract setModelProperty

  • setModelProperty(propertyName: string, modelProperty: null | ModelProperty<Model, unknown, never>): void

  • Parameters

    Returns void

setTrait

  • setTrait(key: string, newTrait: null | Trait): null | Trait

  • Parameters

    • key: string
    • newTrait: null | Trait

    Returns null | Trait

Abstract setTraitFastener

  • Parameters

    Returns void

setTraitFlags

  • setTraitFlags(traitFlags: number): void

  • Parameters

    • traitFlags: number

    Returns void

Abstract setTraitModel

  • Parameters

    Returns void

Abstract setTraitProperty

  • setTraitProperty(propertyName: string, traitProperty: null | TraitProperty<Trait, unknown, never>): void

  • Parameters

    Returns void

Abstract setTraitService

  • setTraitService(serviceName: string, traitService: null | TraitService<Trait, unknown>): void

  • Parameters

    Returns void

Protected startConsuming

  • startConsuming(): void

  • Returns void

Protected stopConsuming

  • stopConsuming(): void

  • Returns void

Protected willAddTraitConsumer

  • willAddTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected willAddTraitObserver

  • Parameters

    Returns void

Protected willAggregate

  • Parameters

    Returns void

Protected willAnalyze

  • willAnalyze(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected willAnalyzeChildModel

  • willAnalyzeChildModel(childModel: Model, analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected willAnalyzeChildModels

  • willAnalyzeChildModels(analyzeFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected willCorrelate

  • Parameters

    Returns void

Protected willInsertChildModel

  • willInsertChildModel(childModel: Model, targetModel: null | Model): void

  • Parameters

    Returns void

Protected willInsertTrait

  • willInsertTrait(trait: Trait, targetTrait: null | Trait): void

  • Parameters

    Returns void

Protected willMount

  • willMount(): void

  • Returns void

Protected willMutate

  • Parameters

    Returns void

Protected willPower

  • willPower(): void

  • Returns void

Protected willReconcile

  • Parameters

    Returns void

Protected willRefresh

  • willRefresh(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected willRefreshChildModel

  • willRefreshChildModel(childModel: Model, refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected willRefreshChildModels

  • willRefreshChildModels(refreshFlags: number, modelContext: ModelContext): void

  • Parameters

    Returns void

Protected willRemoveChildModel

  • willRemoveChildModel(childModel: Model): void

  • Parameters

    Returns void

Protected willRemoveTrait

  • willRemoveTrait(trait: Trait): void

  • Parameters

    Returns void

Protected willRemoveTraitConsumer

  • willRemoveTraitConsumer(traitConsumer: unknown): void

  • Parameters

    • traitConsumer: unknown

    Returns void

Protected willRemoveTraitObserver

  • Parameters

    Returns void

Protected willRequestUpdate

  • willRequestUpdate(targetModel: Model, updateFlags: number, immediate: boolean): void

  • Parameters

    • targetModel: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

Protected willRequireUpdate

  • willRequireUpdate(updateFlags: number, immediate: boolean): void

  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns void

Protected willSetModel

  • willSetModel(newModel: null | Model, oldModel: null | Model): void

  • Parameters

    Returns void

Protected willSetParentModel

  • willSetParentModel(newParentModel: null | Model, oldParentModel: null | Model): void

  • Parameters

    • newParentModel: null | Model
    • oldParentModel: null | Model

    Returns void

Protected willStartConsuming

  • willStartConsuming(): void

  • Returns void

Protected willStopConsuming

  • willStopConsuming(): void

  • Returns void

Protected willUnmount

  • willUnmount(): void

  • Returns void

Protected willUnpower

  • willUnpower(): void

  • Returns void

Protected willValidate

  • Parameters

    Returns void

Static decorateTraitFastener

  • Parameters

    Returns void

Static decorateTraitModel

  • Parameters

    Returns void

Static decorateTraitProperty

  • Parameters

    Returns void

Static decorateTraitService

  • Parameters

    Returns void

Static getModelPropertyConstructor

  • Parameters

    Returns null | ModelPropertyConstructor<Model, unknown, never, {}>

Static getTraitFastenerConstructor

Static getTraitModelConstructor

Static getTraitPropertyConstructor

  • Parameters

    Returns null | TraitPropertyConstructor<Trait, unknown, never, {}>

Static getTraitServiceConstructor

  • Parameters

    Returns null | TraitServiceConstructor<Trait, unknown, {}>

Generated using TypeDoc