Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GenericModel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly childMap

childMap: null | Dictionary<Model>

Readonly children

children: readonly Model[]

Optional Readonly consumerType

consumerType: Class<Consumer<Consumable>>

Readonly consumers

consumers: readonly Consumer<Consumable>[]

Optional Readonly contextType

contextType: Class<ModelContext>

Readonly decoherent

decoherent: null | readonly Fastener<unknown>[]

Optional Readonly familyType

familyType: Class<Model>

Readonly fasteners

fasteners: null | {}

Readonly flags

flags: number

Readonly key

key: undefined | string

Optional Readonly observerType

observerType: Class<ModelObserver<Model>>

Readonly observers

observers: readonly ModelObserver<Model>[]

Readonly parent

parent: null | Model

Readonly refreshProvider

refreshProvider: RefreshProvider<GenericModel, RefreshService<GenericModel>>

Readonly selectionProvider

selectionProvider: SelectionProvider<GenericModel, SelectionService<GenericModel>>

Readonly traitMap

traitMap: null | Dictionary<Trait>

Readonly traits

traits: readonly Trait[]

Readonly uid

uid: number

Readonly warpProvider

warpProvider: WarpProvider<GenericModel, WarpService<GenericModel>>

Readonly warpRef

warpRef: Property<GenericModel, null | WarpRef, null | WarpRef>

Static Readonly AnalyzeMask

AnalyzeMask: number

Static Readonly AnalyzingFlag

AnalyzingFlag: number

Static Readonly ConsumingFlag

ConsumingFlag: number

Static Readonly ContextualFlag

ContextualFlag: number

Static Readonly FlagMask

FlagMask: number

Static Readonly FlagShift

FlagShift: number

Static Readonly InsertChildFlags

InsertChildFlags: number

Static Readonly InsertTraitFlags

InsertTraitFlags: number

Static Readonly MountFlags

MountFlags: number

Static Readonly MountedFlag

MountedFlag: number

Static Readonly NeedsAggregate

NeedsAggregate: number

Static Readonly NeedsAnalyze

NeedsAnalyze: number

Static Readonly NeedsCorrelate

NeedsCorrelate: number

Static Readonly NeedsMutate

NeedsMutate: number

Static Readonly NeedsReconcile

NeedsReconcile: number

Static Readonly NeedsRefresh

NeedsRefresh: number

Static Readonly NeedsValidate

NeedsValidate: number

Static Readonly RefreshMask

RefreshMask: number

Static Readonly RefreshingFlag

RefreshingFlag: number

Static Readonly RemoveChildFlags

RemoveChildFlags: number

Static Readonly RemoveTraitFlags

RemoveTraitFlags: number

Static Readonly RemovingFlag

RemovingFlag: number

Static Readonly StartConsumingFlags

StartConsumingFlags: number

Static Readonly StatusMask

StatusMask: number

Static Readonly StopConsumingFlags

StopConsumingFlags: number

Static Readonly TraversingFlag

TraversingFlag: number

Static Readonly UpdateMask

UpdateMask: number

Static Readonly UpdatingMask

UpdatingMask: number

Static uid

uid: () => number

Type declaration

    • (): number

    • Returns number

Accessors

analyzing

  • get analyzing(): boolean

  • Returns boolean

childCount

  • get childCount(): number

  • Returns number

consuming

  • get consuming(): boolean

  • Returns boolean

insertChildFlags

  • get insertChildFlags(): number

  • Returns number

insertTraitFlags

  • get insertTraitFlags(): number

  • Returns number

modelContext

  • Returns ModelContextType<this>

mountFlags

  • get mountFlags(): number

  • Returns number

mounted

  • get mounted(): boolean

  • Returns boolean

refreshing

  • get refreshing(): boolean

  • Returns boolean

removeChildFlags

  • get removeChildFlags(): number

  • Returns number

removeTraitFlags

  • get removeTraitFlags(): number

  • Returns number

startConsumingFlags

  • get startConsumingFlags(): number

  • Returns number

stopConsumingFlags

  • get stopConsumingFlags(): number

  • Returns number

superModelContext

  • Returns ModelContext

traitCount

  • get traitCount(): number

  • Returns number

traversing

  • get traversing(): boolean

  • Returns boolean

updating

  • get updating(): boolean

  • Returns boolean

Methods

Protected analyzeChild

  • Parameters

    Returns void

Protected analyzeChildren

  • analyzeChildren(analyzeFlags: number, modelContext: ModelContext, analyzeChild: (child: Model, analyzeFlags: number, modelContext: ModelContext) => void): void

  • Parameters

    Returns void

Protected analyzeOwnChildren

  • analyzeOwnChildren(analyzeFlags: number, modelContext: ModelContext, analyzeChild: (child: Model, analyzeFlags: number, modelContext: ModelContext) => void): void

  • Parameters

    Returns void

Protected analyzeTraitChildren

  • analyzeTraitChildren(traits: readonly Trait[], traitIndex: number, analyzeFlags: number, modelContext: ModelContext, analyzeChild: (child: Model, analyzeFlags: number, modelContext: ModelContext) => void): void

  • Parameters

    Returns void

appendChild

  • appendChild<M>(child: M, key?: string): M
  • appendChild<F>(factory: F, key?: string): InstanceType<F>
  • appendChild(child: AnyModel<Model>, key?: string): Model

  • Type parameters

    Parameters

    • child: M
    • Optional key: string

    Returns M

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Model

appendTrait

  • appendTrait<T>(trait: T, key?: string): T
  • appendTrait<F>(factory: F, key?: string): InstanceType<F>
  • appendTrait(trait: AnyTrait<Trait>, key?: string): Trait

  • Type parameters

    Parameters

    • trait: T
    • Optional key: string

    Returns T

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Trait

Protected attachFastener

  • attachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

attachParent

  • attachParent(parent: Model): void

  • Parameters

    Returns void

Protected bindChildFastener

  • bindChildFastener(fastener: Fastener<unknown>, child: Model, target: null | Model): void

  • Parameters

    Returns void

Protected bindChildFasteners

  • bindChildFasteners(child: Model, target: null | Model): void

  • Parameters

    Returns void

Protected bindFastener

  • bindFastener(fastener: Fastener<unknown>): void

  • Parameters

    Returns void

Protected bindTraitFastener

  • bindTraitFastener(fastener: Fastener<unknown>, trait: Trait, target: null | Trait): void

  • Parameters

    Returns void

Protected bindTraitFasteners

  • bindTraitFasteners(trait: Trait, target: null | Trait): void

  • Parameters

    Returns void

callObservers

  • Type parameters

    • O

    • K: string | number | symbol

    Parameters

    Returns void

cascadeAnalyze

  • cascadeAnalyze(analyzeFlags: number, baesModelContext: ModelContext): void

  • Parameters

    Returns void

cascadeInsert

  • cascadeInsert(updateFlags?: number, modelContext?: ModelContext): void

  • Parameters

    • Optional updateFlags: number
    • Optional modelContext: ModelContext

    Returns void

cascadeMount

  • cascadeMount(): void

  • Returns void

cascadeRefresh

  • cascadeRefresh(refreshFlags: number, baseModelContext: ModelContext): void

  • Parameters

    Returns void

cascadeUnmount

  • cascadeUnmount(): void

  • Returns void

consume

  • Parameters

    Returns void

decohereFastener

  • decohereFastener(fastener: Fastener<unknown>): void

  • Parameters

    Returns void

Protected detachFastener

  • detachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

detachParent

  • detachParent(parent: Model): void

  • Parameters

    Returns void

Protected didAggregate

  • Parameters

    Returns void

Protected didAnalyze

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

  • Parameters

    Returns void

Protected didAttachFastener

  • didAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected didAttachParent

  • didAttachParent(parent: Model): void

  • Parameters

    Returns void

Protected didConsume

  • Parameters

    Returns void

Protected didCorrelate

  • Parameters

    Returns void

Protected didDetachFastener

  • didDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected didDetachParent

  • didDetachParent(parent: Model): void

  • Parameters

    Returns void

Protected didInsertChild

  • didInsertChild(child: Model, target: null | Model): void

  • Parameters

    Returns void

Protected didInsertTrait

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

  • Parameters

    Returns void

Protected didMount

  • didMount(): void

  • Returns void

Protected didMutate

  • Parameters

    Returns void

Protected didObserve

  • Parameters

    Returns void

Protected didReconcile

  • Parameters

    Returns void

Protected didRefresh

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

  • Parameters

    Returns void

Protected didRemoveChild

  • didRemoveChild(child: Model): void

  • Parameters

    Returns void

Protected didRemoveTrait

  • didRemoveTrait(trait: Trait): void

  • Parameters

    Returns void

Protected didStartConsuming

  • didStartConsuming(): void

  • Returns void

Protected didStopConsuming

  • didStopConsuming(): void

  • Returns void

Protected didUnconsume

Protected didUnmount

  • didUnmount(): void

  • Returns void

Protected didUnobserve

  • Parameters

    Returns void

Protected didValidate

  • Parameters

    Returns void

equals

  • equals(that: unknown): boolean

  • Parameters

    • that: unknown

    Returns boolean

extendModelContext

firstChild

  • firstChild(): null | Model

  • Returns null | Model

firstTrait

  • firstTrait(): null | Trait

  • Returns null | Trait

forEachChild

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

  • Type parameters

    • T

    Parameters

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

        • Parameters

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

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

        • Parameters

          Returns void | T

    • thisArg: S

    Returns undefined | T

forEachObserver

  • forEachObserver<T>(callback: (observer: ModelObserver<Model>) => void | T): 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

getBase

  • getBase<F>(baseBound: F): null | InstanceType<F>

  • Type parameters

    Parameters

    • baseBound: F

    Returns null | InstanceType<F>

getBaseTrait

  • getBaseTrait<F>(baseBound: F): null | InstanceType<F>

  • Type parameters

    • F: new (...args: any[]) => Trait

    Parameters

    • baseBound: F

    Returns null | InstanceType<F>

getChild

  • getChild<F>(key: string, childBound: F): null | InstanceType<F>
  • getChild(key: string, childBound?: new (...args: any[]) => Model): null | Model

  • Type parameters

    • F: new (...args: any[]) => Model

    Parameters

    • key: string
    • childBound: F

    Returns null | InstanceType<F>

  • Parameters

    • key: string
    • Optional childBound: new (...args: any[]) => Model
        • new (...args: any[]): Model

        • Parameters

          • Rest ...args: any[]

          Returns Model

    Returns null | Model

getFastener

  • getFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getLazyFastener

  • getLazyFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getLazyFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getSuper

  • getSuper<F>(superBound: F): null | InstanceType<F>

  • Type parameters

    Parameters

    • superBound: F

    Returns null | InstanceType<F>

getSuperFastener

  • getSuperFastener<F>(fastenerName: string, fastenerBound: Class<F>): null | F
  • getSuperFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>

  • Type parameters

    Parameters

    • fastenerName: string
    • fastenerBound: Class<F>

    Returns null | F

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns null | Fastener<unknown>

getSuperTrait

  • getSuperTrait<F>(superBound: F): null | InstanceType<F>

  • Type parameters

    • F: new (...args: any[]) => Trait

    Parameters

    • superBound: F

    Returns null | InstanceType<F>

getTrait

  • getTrait<F>(key: string, traitBound: F): null | InstanceType<F>
  • getTrait(key: string, traitBound?: new (...args: any[]) => Trait): null | Trait
  • getTrait<F>(traitBound: F): null | InstanceType<F>

  • Type parameters

    • F: new (...args: any[]) => Trait

    Parameters

    • key: string
    • traitBound: F

    Returns null | InstanceType<F>

  • Parameters

    • key: string
    • Optional traitBound: new (...args: any[]) => Trait
        • new (...args: any[]): Trait

        • Parameters

          • Rest ...args: any[]

          Returns Trait

    Returns null | Trait

  • Type parameters

    • F: new (...args: any[]) => Trait

    Parameters

    • traitBound: F

    Returns null | InstanceType<F>

hasFastener

  • hasFastener(fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): boolean

  • Parameters

    • fastenerName: string
    • Optional fastenerBound: null | Class<Fastener<unknown>>

    Returns boolean

hashCode

  • hashCode(): number

  • Returns number

init

  • Parameters

    Returns void

insertChild

  • insertChild<M>(child: M, target: null | Model, key?: string): M
  • insertChild<F>(factory: F, target: null | Model, key?: string): InstanceType<F>
  • insertChild(child: AnyModel<Model>, target: null | Model, key?: string): Model

  • Type parameters

    Parameters

    • child: M
    • target: null | Model
    • Optional key: string

    Returns M

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • target: null | Model
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Model

Protected insertChildMap

  • insertChildMap(child: Model): void

  • Parameters

    Returns void

insertTrait

  • insertTrait<T>(trait: T, target: null | Trait, key?: string): T
  • insertTrait<F>(factory: F, target: null | Trait, key?: string): InstanceType<F>
  • insertTrait(trait: AnyTrait<Trait>, target: null | Trait, key?: string): Trait

  • Type parameters

    Parameters

    • trait: T
    • target: null | Trait
    • Optional key: string

    Returns T

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • target: null | Trait
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Trait

Protected insertTraitMap

  • insertTraitMap(trait: Trait): void

  • Parameters

    Returns void

lastChild

  • lastChild(): null | Model

  • Returns null | Model

lastTrait

  • lastTrait(): null | Trait

  • Returns null | Trait

mount

  • mount(): void

  • Returns void

Protected mountChildren

  • mountChildren(): void

  • Returns void

Protected mountFasteners

  • mountFasteners(): void

  • Returns void

Protected mountTraits

  • mountTraits(): void

  • Returns void

Protected needsAnalyze

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

  • Parameters

    Returns number

Protected needsRefresh

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

  • Parameters

    Returns number

Protected needsUpdate

  • needsUpdate(updateFlags: number, immediate: boolean): number

  • Parameters

    • updateFlags: number
    • immediate: boolean

    Returns number

nextChild

  • Parameters

    Returns null | Model

nextTrait

  • Parameters

    Returns null | Trait

observe

  • Parameters

    Returns void

Protected onAggregate

  • Parameters

    Returns void

Protected onAnalyze

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

  • Parameters

    Returns void

Protected onAttachFastener

  • onAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected onAttachParent

  • onAttachParent(parent: Model): void

  • Parameters

    Returns void

Protected onConsume

  • Parameters

    Returns void

Protected onCorrelate

  • Parameters

    Returns void

Protected onDetachFastener

  • onDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected onDetachParent

  • onDetachParent(parent: Model): void

  • Parameters

    Returns void

Protected onInsertChild

  • onInsertChild(child: Model, target: null | Model): void

  • Parameters

    Returns void

Protected onInsertTrait

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

  • Parameters

    Returns void

Protected onMount

  • onMount(): void

  • Returns void

Protected onMutate

  • Parameters

    Returns void

Protected onObserve

  • Parameters

    Returns void

Protected onReconcile

  • Parameters

    Returns void

Protected onRefresh

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

  • Parameters

    Returns void

Protected onRemoveChild

  • onRemoveChild(child: Model): void

  • Parameters

    Returns void

Protected onRemoveTrait

  • onRemoveTrait(trait: Trait): void

  • Parameters

    Returns void

Protected onStartConsuming

  • onStartConsuming(): void

  • Returns void

Protected onStopConsuming

  • onStopConsuming(): void

  • Returns void

Protected onUnconsume

Protected onUnmount

  • onUnmount(): void

  • Returns void

Protected onUnobserve

  • Parameters

    Returns void

Protected onValidate

  • Parameters

    Returns void

prependChild

  • prependChild<M>(child: M, key?: string): M
  • prependChild<F>(factory: F, key?: string): InstanceType<F>
  • prependChild(child: AnyModel<Model>, key?: string): Model

  • Type parameters

    Parameters

    • child: M
    • Optional key: string

    Returns M

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Model

prependTrait

  • prependTrait<T>(trait: T, key?: string): T
  • prependTrait<F>(factory: F, key?: string): InstanceType<F>
  • prependTrait(trait: AnyTrait<Trait>, key?: string): Trait

  • Type parameters

    Parameters

    • trait: T
    • Optional key: string

    Returns T

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • factory: F
    • Optional key: string

    Returns InstanceType<F>

  • Parameters

    Returns Trait

previousChild

  • Parameters

    Returns null | Model

previousTrait

  • Parameters

    Returns null | Trait

recohereDownlinks

  • recohereDownlinks(t: number): void

  • Parameters

    • t: number

    Returns void

recohereFasteners

  • recohereFasteners(t?: number): void

  • Parameters

    • Optional t: number

    Returns void

Protected refreshChild

  • Parameters

    Returns void

Protected refreshChildren

  • refreshChildren(refreshFlags: number, modelContext: ModelContext, refreshChild: (child: Model, refreshFlags: number, modelContext: ModelContext) => void): void

  • Parameters

    Returns void

Protected refreshOwnChildren

  • refreshOwnChildren(refreshFlags: number, modelContext: ModelContext, refreshChild: (child: Model, refreshFlags: number, modelContext: ModelContext) => void): void

  • Parameters

    Returns void

Protected refreshTraitChildren

  • refreshTraitChildren(traits: readonly Trait[], traitIndex: number, refreshFlags: number, modelContext: ModelContext, refreshChild: (child: Model, refreshFlags: number, modelContext: ModelContext) => void): void

  • Parameters

    Returns void

remove

  • remove(): void

  • Returns void

removeChild

  • removeChild(key: string): null | Model
  • removeChild<M>(child: M): M

  • Parameters

    • key: string

    Returns null | Model

  • Type parameters

    Parameters

    • child: M

    Returns M

Protected removeChildMap

  • removeChildMap(child: Model): void

  • Parameters

    Returns void

removeChildren

  • removeChildren(): void

  • Returns void

removeTrait

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

  • Parameters

    • key: string

    Returns null | Trait

  • Parameters

    Returns void

Protected removeTraitMap

  • removeTraitMap(trait: Trait): void

  • Parameters

    Returns void

replaceChild

  • replaceChild<M>(newChild: Model, oldChild: M): M
  • replaceChild<M>(newChild: AnyModel<Model>, oldChild: M): M

  • Type parameters

    Parameters

    • newChild: Model
    • oldChild: M

    Returns M

  • Type parameters

    Parameters

    Returns M

Protected replaceChildMap

  • replaceChildMap(newChild: Model, oldChild: Model): void

  • Parameters

    Returns void

replaceTrait

  • replaceTrait<T>(newTrait: Trait, oldTrait: T): T
  • replaceTrait<T>(newTrait: AnyTrait<Trait>, oldTrait: T): T

  • Type parameters

    Parameters

    • newTrait: Trait
    • oldTrait: T

    Returns T

  • Type parameters

    Parameters

    Returns T

Protected replaceTraitMap

  • replaceTraitMap(newTrait: Trait, oldTrait: Trait): void

  • Parameters

    Returns void

requestUpdate

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

  • Parameters

    • target: Model
    • updateFlags: number
    • immediate: boolean

    Returns void

requireUpdate

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

  • Parameters

    • updateFlags: number
    • Optional immediate: boolean

    Returns void

setChild

  • setChild<M>(key: string, newChild: M): null | Model
  • setChild<F>(key: string, factory: F): null | Model
  • setChild(key: string, newChild: null | AnyModel<Model>): null | Model

  • Type parameters

    Parameters

    • key: string
    • newChild: M

    Returns null | Model

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • key: string
    • factory: F

    Returns null | Model

  • Parameters

    Returns null | Model

setFastener

  • setFastener(fastenerName: string, newFastener: null | Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • newFastener: null | Fastener<unknown>

    Returns void

setFlags

  • setFlags(flags: number): void

  • Parameters

    • flags: number

    Returns void

setKey

  • setKey(key: undefined | string): void

  • Parameters

    • key: undefined | string

    Returns void

setTrait

  • setTrait<T>(key: string, newTrait: T): null | Trait
  • setTrait<F>(key: string, factory: F): null | Trait
  • setTrait(key: string, newTrait: null | AnyTrait<Trait>): null | Trait

  • Type parameters

    Parameters

    • key: string
    • newTrait: T

    Returns null | Trait

  • Type parameters

    • F: new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>, F>

    Parameters

    • key: string
    • factory: F

    Returns null | Trait

  • Parameters

    Returns null | Trait

Protected startConsuming

  • startConsuming(): void

  • Returns void

Protected startConsumingFasteners

  • startConsumingFasteners(): void

Protected stopConsuming

  • stopConsuming(): void

  • Returns void

Protected stopConsumingFasteners

  • stopConsumingFasteners(): void

  • Returns void

Protected unbindChildFastener

  • unbindChildFastener(fastener: Fastener<unknown>, child: Model): void

  • Parameters

    Returns void

Protected unbindChildFasteners

  • unbindChildFasteners(child: Model): void

  • Parameters

    Returns void

Protected unbindTraitFastener

  • unbindTraitFastener(fastener: Fastener<unknown>, trait: Trait): void

  • Parameters

    Returns void

Protected unbindTraitFasteners

  • unbindTraitFasteners(trait: Trait): void

  • Parameters

    Returns void

unconsume

  • Parameters

    Returns void

Protected unmountChildren

  • unmountChildren(): void

  • Returns void

Protected unmountFasteners

  • unmountFasteners(): void

  • Returns void

Protected unmountTraits

  • unmountTraits(): void

  • Returns void

unobserve

  • Parameters

    Returns void

Protected willAggregate

  • Parameters

    Returns void

Protected willAnalyze

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

  • Parameters

    Returns void

Protected willAttachFastener

  • willAttachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected willAttachParent

  • willAttachParent(parent: Model): void

  • Parameters

    Returns void

Protected willConsume

Protected willCorrelate

  • Parameters

    Returns void

Protected willDetachFastener

  • willDetachFastener(fastenerName: string, fastener: Fastener<unknown>): void

  • Parameters

    • fastenerName: string
    • fastener: Fastener<unknown>

    Returns void

Protected willDetachParent

  • willDetachParent(parent: Model): void

  • Parameters

    Returns void

Protected willInsertChild

  • willInsertChild(child: Model, target: null | Model): void

  • Parameters

    Returns void

Protected willInsertTrait

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

  • Parameters

    Returns void

Protected willMount

  • willMount(): void

  • Returns void

Protected willMutate

  • Parameters

    Returns void

Protected willObserve

  • Parameters

    Returns void

Protected willReconcile

  • Parameters

    Returns void

Protected willRefresh

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

  • Parameters

    Returns void

Protected willRemoveChild

  • willRemoveChild(child: Model): void

  • Parameters

    Returns void

Protected willRemoveTrait

  • willRemoveTrait(trait: Trait): void

  • Parameters

    Returns void

Protected willStartConsuming

  • willStartConsuming(): void

  • Returns void

Protected willStopConsuming

  • willStopConsuming(): void

  • Returns void

Protected willUnconsume

Protected willUnmount

  • willUnmount(): void

  • Returns void

Protected willUnobserve

  • Parameters

    Returns void

Protected willValidate

  • Parameters

    Returns void

Static create

  • create<S>(): InstanceType<S>

  • Type parameters

    • S: new () => InstanceType<S>

    Returns InstanceType<S>

Static fromAny

  • fromAny<S>(value: AnyModel<InstanceType<S>>): InstanceType<S>

  • Type parameters

    • S: new (...args: any[]) => InstanceType<S>

    Parameters

    Returns InstanceType<S>

Static fromInit

  • fromInit<S>(init: InitType<InstanceType<S>>): InstanceType<S>

  • Type parameters

    • S: new (...args: any[]) => InstanceType<S>

    Parameters

    Returns InstanceType<S>

Generated using TypeDoc