Interface ModelRef<R, M, I>

Type Parameters

  • R = any

  • M extends Model = Model

  • I extends any[] = [M | null]

Hierarchy

Properties

coherentTime inlet inletVersion model name owner version

Accessors

affinity binds coherent consumed consuming derived descriptorType fastenerType inheritName inherits inletKeys inletModel modelKey modelType mounted observes parent parentModel parentType

Methods

attachFastener attachInlets attachModel bindInlet consume createModel decohere decohereFastener deinitModel deleteModel detachInlets detachModel detectModel didAttachModel didBindInlet didConsume didDetachModel didMount didSetAffinity didSetInherits didStartConsuming didStopConsuming didUnbindInlet didUnconsume didUnmount fromLike get getFastener getInletModel getModel getParentFastener getTransition? hasAffinity incrementVersion init initModel insertChild insertModel onAttachModel onBindInlet onConsume onDetachModel onMount onSetAffinity onSetInherits onStartConsuming onStopConsuming onUnbindInlet onUnconsume onUnmount recohere removeModel requireRecohere requireUpdate resolveInlets set setAffinity setCoherent setCoherentTime setInherits setIntrinsic setModel toString unbindInlet unconsume willAttachModel willBindInlet willConsume willDetachModel willMount willSetAffinity willSetInherits willStartConsuming willStopConsuming willUnbindInlet willUnconsume willUnmount

Properties

Readonly coherentTime

coherentTime: number

Readonly inlet

inlet: Fastener<any, any, any> | readonly Fastener<any, any, any>[]

Readonly inletVersion

inletVersion: number | readonly number[]

Readonly model

model: M

Readonly name

name: PropertyKey

Readonly owner

owner: R

Readonly version

version: number

Accessors

affinity

  • get affinity(): Affinity

  • Returns Affinity

binds

  • get binds(): boolean

  • Returns boolean

coherent

  • get coherent(): boolean

  • Returns boolean

consumed

  • get consumed(): boolean

  • Returns boolean

consuming

  • get consuming(): boolean

  • Returns boolean

derived

  • get derived(): boolean

  • Returns boolean

descriptorType

  • get descriptorType(): Proto<ModelRefDescriptor<R, M>>

  • Returns Proto<ModelRefDescriptor<R, M>>

fastenerType

  • get fastenerType(): Proto<ModelRef<any, any, any>>

  • Returns Proto<ModelRef<any, any, any>>

inheritName

  • get inheritName(): PropertyKey

  • Returns PropertyKey

inherits

  • get inherits(): boolean

  • Returns boolean

inletKeys

  • get inletKeys(): readonly PropertyKey[]
  • Protected

    Returns readonly PropertyKey[]

inletModel

  • get inletModel(): M

  • Returns M

modelKey

  • get modelKey(): string

  • Returns string

modelType

  • get modelType(): ModelFactory<M>

  • Returns ModelFactory<M>

mounted

  • get mounted(): boolean

  • Returns boolean

observes

  • get observes(): boolean

  • Returns boolean

parent

  • get parent(): ModelRef<any, M, any>

  • Returns ModelRef<any, M, any>

parentModel

  • get parentModel(): Model

  • Returns Model

parentType

  • get parentType(): Proto<any>

  • Returns Proto<any>

Methods

attachFastener

  • Parameters

    • fastener: Fastener<any, any, any>

    Returns void

Protected attachInlets

  • Protected

    Returns void

attachModel

  • Parameters

    • Optional model: M | LikeType<M>
    • Optional target: Model

    Returns M

bindInlet

  • Type Parameters

    • K extends string | number | symbol

    • IK

    Parameters

    • inlet: Fastener<any, IK, any>
    • key: IK

    Returns void

  • Type Parameters

    • I0 extends any

    Parameters

    • inlet: Fastener<any, I0, any>

    Returns void

consume

  • Parameters

    • consumer: unknown

    Returns void

createModel

  • Returns M

decohere

  • Parameters

    • Optional inlet: Fastener<any, any, any>

    Returns void

decohereFastener

  • Parameters

    • fastener: Fastener<any, any, any>

    Returns void

Protected deinitModel

  • Protected

    Parameters

    • model: M

    Returns void

deleteModel

  • Returns M

Protected detachInlets

  • Protected

    Returns void

detachModel

  • Returns M

detectModel

  • Parameters

    Returns M

Protected didAttachModel

  • Protected

    Parameters

    Returns void

Protected didBindInlet

  • Protected

    Parameters

    • inlet: Fastener<any, any, any>

    Returns void

Protected didConsume

  • Protected

    Parameters

    • consumer: unknown

    Returns void

Protected didDetachModel

  • Protected

    Parameters

    • model: M

    Returns void

Protected didMount

  • Protected

    Returns void

Protected didSetAffinity

  • Protected

    Parameters

    • newAffinity: Affinity
    • oldAffinity: Affinity

    Returns void

Protected didSetInherits

  • Protected

    Parameters

    • inherits: boolean
    • inheritName: PropertyKey

    Returns void

Protected didStartConsuming

  • Protected

    Returns void

Protected didStopConsuming

  • Protected

    Returns void

Protected didUnbindInlet

  • Protected

    Parameters

    • inlet: Fastener<any, any, any>

    Returns void

Protected didUnconsume

  • Protected

    Parameters

    • consumer: unknown

    Returns void

Protected didUnmount

  • Protected

    Returns void

Protected fromLike

  • Protected

    Parameters

    • value: M | LikeType<M>

    Returns M

get

  • Returns M

getFastener

  • Type Parameters

    • F extends Fastener<any, any, [any]>

    Parameters

    • fastenerName: PropertyKey
    • Optional fastenerType: Proto<F>
    • Optional contextType: Proto<any>

    Returns F

getInletModel

  • Returns M

getModel

  • Returns M

getParentFastener

  • Type Parameters

    • F extends Fastener<any, any, [any]>

    Parameters

    • fastenerName: string
    • Optional fastenerType: Proto<F>
    • Optional contextType: Proto<any>

    Returns F

Optional getTransition

  • Parameters

    • fastener: Fastener<any, any, any>

    Returns Timing

hasAffinity

  • Parameters

    • affinity: Affinity

    Returns boolean

Protected incrementVersion

  • Protected

    Returns void

Protected init

  • Protected

    Returns void

Protected initModel

  • Protected

    Parameters

    • model: M

    Returns void

Protected insertChild

  • Protected

    Parameters

    Returns void

insertModel

  • Parameters

    • Optional parent: Model
    • Optional model: M | LikeType<M>
    • Optional target: Model
    • Optional key: string

    Returns M

Protected onAttachModel

  • Protected

    Parameters

    Returns void

Protected onBindInlet

  • Protected

    Parameters

    • inlet: Fastener<any, any, any>

    Returns void

Protected onConsume

  • Protected

    Parameters

    • consumer: unknown

    Returns void

Protected onDetachModel

  • Protected

    Parameters

    • model: M

    Returns void

Protected onMount

  • Protected

    Returns void

Protected onSetAffinity

  • Protected

    Parameters

    • newAffinity: Affinity
    • oldAffinity: Affinity

    Returns void

Protected onSetInherits

  • Protected

    Parameters

    • inherits: boolean
    • inheritName: PropertyKey

    Returns void

Protected onStartConsuming

  • Protected

    Returns void

Protected onStopConsuming

  • Protected

    Returns void

Protected onUnbindInlet

  • Protected

    Parameters

    • inlet: Fastener<any, any, any>

    Returns void

Protected onUnconsume

  • Protected

    Parameters

    • consumer: unknown

    Returns void

Protected onUnmount

  • Protected

    Returns void

recohere

  • Parameters

    • t: number

    Returns void

removeModel

  • Returns M

requireRecohere

  • Returns void

requireUpdate

  • Parameters

    • updateFlags: number

    Returns void

resolveInlets

  • Returns readonly Fastener<any, any, any>[]

set

  • Parameters

    • model: M | Fastener<any, I[0], any> | LikeType<M>

    Returns R

setAffinity

  • Parameters

    • affinity: Affinity

    Returns void

Protected setCoherent

  • Protected

    Parameters

    • coherent: boolean

    Returns void

Protected setCoherentTime

  • Protected

    Parameters

    • coherentTime: number

    Returns void

setInherits

  • Parameters

    • inherits: boolean | PropertyKey

    Returns void

setIntrinsic

  • Parameters

    • model: M | Fastener<any, I[0], any> | LikeType<M>

    Returns R

setModel

  • Parameters

    • model: M | LikeType<M>
    • Optional target: Model
    • Optional key: string

    Returns M

toString

  • Returns string

unbindInlet

  • Parameters

    • Optional inlet: Fastener<any, any, any>

    Returns void

unconsume

  • Parameters

    • consumer: unknown

    Returns void

Protected willAttachModel

  • Protected

    Parameters

    Returns void

Protected willBindInlet

  • Protected

    Parameters

    • inlet: Fastener<any, any, any>

    Returns void

Protected willConsume

  • Protected

    Parameters

    • consumer: unknown

    Returns void

Protected willDetachModel

  • Protected

    Parameters

    • model: M

    Returns void

Protected willMount

  • Protected

    Returns void

Protected willSetAffinity

  • Protected

    Parameters

    • newAffinity: Affinity
    • oldAffinity: Affinity

    Returns void

Protected willSetInherits

  • Protected

    Parameters

    • inherits: boolean
    • inheritName: PropertyKey

    Returns void

Protected willStartConsuming

  • Protected

    Returns void

Protected willStopConsuming

  • Protected

    Returns void

Protected willUnbindInlet

  • Protected

    Parameters

    • inlet: Fastener<any, any, any>

    Returns void

Protected willUnconsume

  • Protected

    Parameters

    • consumer: unknown

    Returns void

Protected willUnmount

  • Protected

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc