Interface ComponentRef<R, C, I>

Type Parameters

R = any
C extends Component<any> = Component
I extends any[] = [C | null]

Hierarchy

ComponentRelation<R, C, I>
- ComponentRef

Index

Properties

`Readonly` coherentTime

coherentTime: number

`Readonly` component

component: C

`Readonly` inlet

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

`Readonly` inletVersion

inletVersion: number | readonly number[]

`Readonly` name

name: PropertyKey

`Readonly` owner

owner: R

`Readonly` version

version: number

Accessors

affinity

get affinity(): Affinity
Returns Affinity
Inherited from ComponentRelation.affinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:146

binds

get binds(): boolean
Returns boolean
Inherited from ComponentRelation.binds
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:92

coherent

get coherent(): boolean
Returns boolean
Inherited from ComponentRelation.coherent
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:160

componentKey

get componentKey(): string
Returns string
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:32

componentType

get componentType(): ComponentFactory<C>
Returns ComponentFactory<C>
Inherited from ComponentRelation.componentType
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:21

derived

get derived(): boolean
Returns boolean
Inherited from ComponentRelation.derived
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:143

descriptorType

get descriptorType(): Proto<ComponentRefDescriptor<R, C>>
Returns Proto<ComponentRefDescriptor<R, C>>
Overrides ComponentRelation.descriptorType
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:22

fastenerType

get fastenerType(): Proto<ComponentRef<any, any, any>>
Returns Proto<ComponentRef<any, any, any>>
Overrides ComponentRelation.fastenerType
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:24

inheritName

get inheritName(): PropertyKey
Returns PropertyKey
Inherited from ComponentRelation.inheritName
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:134

inherits

get inherits(): boolean
Returns boolean
Inherited from ComponentRelation.inherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:135

inletComponent

get inletComponent(): C
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:27

inletKeys

get inletKeys(): readonly PropertyKey[]
Protected
Returns readonly PropertyKey[]
Inherited from ComponentRelation.inletKeys
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:167

mounted

get mounted(): boolean
Returns boolean
Inherited from ComponentRelation.mounted
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:189

observes

get observes(): boolean
Returns boolean
Inherited from ComponentRelation.observes
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:22

parent

get parent(): ComponentRef<any, C, any>
Returns ComponentRef<any, C, any>
Overrides ComponentRelation.parent
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:26

parentComponent

get parentComponent(): Component<any>
Protected
Returns Component<any>
Inherited from ComponentRelation.parentComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:50

parentType

get parentType(): Proto<any>
Returns Proto<any>
Inherited from ComponentRelation.parentType
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:107

Methods

attachComponent

attachComponent(component?, target?): C
Parameters
- Optional component: C | LikeType<C>
- Optional target: Component<any>
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:36

attachFastener

attachFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.attachFastener
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:178

`Protected` attachInlets

attachInlets(): void
Protected
Returns void
Inherited from ComponentRelation.attachInlets
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:170

bindInlet

bindInlet<K, IK>(inlet, key): void
Type Parameters
- K extends string | number | symbol
- IK
Parameters
- inlet: Fastener<any, IK, any>
- key: IK
Returns void
Inherited from ComponentRelation.bindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:113
bindInlet<I0>(inlet): void
Type Parameters
- I0 extends any
Parameters
- inlet: Fastener<any, I0, any>
Returns void
Inherited from ComponentRelation.bindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:114

createComponent

createComponent(): C
Returns C
Inherited from ComponentRelation.createComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:58

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.decohere
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:163

decohereFastener

decohereFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.decohereFastener
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:180

`Protected` deinitComponent

deinitComponent(component): void
Protected
Parameters
- component: C
Returns void
Inherited from ComponentRelation.deinitComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:42

deleteComponent

deleteComponent(): C
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:40

detachComponent

detachComponent(): C
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:37

`Protected` detachInlets

detachInlets(): void
Protected
Returns void
Inherited from ComponentRelation.detachInlets
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:172

detectComponent

detectComponent(component): C
Parameters
- component: Component<any>
Returns C
Overrides ComponentRelation.detectComponent
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:46

`Protected` didAttachComponent

didAttachComponent(component, target): void
Protected
Parameters
- component: C
- target: Component<any>
Returns void
Inherited from ComponentRelation.didAttachComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:40

`Protected` didBindInlet

didBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.didBindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:120

`Protected` didDetachComponent

didDetachComponent(component): void
Protected
Parameters
- component: C
Returns void
Inherited from ComponentRelation.didDetachComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:48

`Protected` didMount

didMount(): void
Protected
Returns void
Inherited from ComponentRelation.didMount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:197

`Protected` didSetAffinity

didSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ComponentRelation.didSetAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:158

`Protected` didSetInherits

didSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ComponentRelation.didSetInherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:142

`Protected` didUnbindInlet

didUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.didUnbindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:129

`Protected` didUnmount

didUnmount(): void
Protected
Returns void
Inherited from ComponentRelation.didUnmount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:205

fromLike

fromLike(value): C
Parameters
- value: C | LikeType<C>
Returns C
Inherited from ComponentRelation.fromLike
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:59

get

get(): C
Returns C
Overrides ComponentRelation.get
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:29

getComponent

getComponent(): C
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:34

getFastener

getFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, [any]>
Parameters
- fastenerName: PropertyKey
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from ComponentRelation.getFastener
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:174

getInletComponent

getInletComponent(): C
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:28

getParentFastener

getParentFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, [any]>
Parameters
- fastenerName: string
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from ComponentRelation.getParentFastener
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:176

`Optional` getTransition

getTransition(fastener): Timing
Parameters
- fastener: Fastener<any, any, any>
Returns Timing
Inherited from ComponentRelation.getTransition
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:184

hasAffinity

hasAffinity(affinity): boolean
Parameters
- affinity: Affinity
Returns boolean
Inherited from ComponentRelation.hasAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:147

`Protected` incrementVersion

incrementVersion(): void
Protected
Returns void
Inherited from ComponentRelation.incrementVersion
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:106

`Protected` init

init(): void
Protected
Returns void
Inherited from ComponentRelation.init
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:94

`Protected` initComponent

initComponent(component): void
Protected
Parameters
- component: C
Returns void
Inherited from ComponentRelation.initComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:34

`Protected` insertChild

insertChild(parent, child, target, key): void
Protected
Parameters
- parent: Component<any>
- child: C
- target: Component<any>
- key: string
Returns void
Inherited from ComponentRelation.insertChild
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:52

insertComponent

insertComponent(parent?, component?, target?, key?): C
Parameters
- Optional parent: Component<any>
- Optional component: C | LikeType<C>
- Optional target: Component<any>
- Optional key: string
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:38

`Protected` onAttachComponent

onAttachComponent(component, target): void
Protected
Parameters
- component: C
- target: Component<any>
Returns void
Inherited from ComponentRelation.onAttachComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:38

`Protected` onBindInlet

onBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.onBindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:118

`Protected` onDetachComponent

onDetachComponent(component): void
Protected
Parameters
- component: C
Returns void
Inherited from ComponentRelation.onDetachComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:46

`Protected` onMount

onMount(): void
Protected
Returns void
Inherited from ComponentRelation.onMount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:195

`Protected` onSetAffinity

onSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ComponentRelation.onSetAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:156

`Protected` onSetInherits

onSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ComponentRelation.onSetInherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:140

`Protected` onUnbindInlet

onUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.onUnbindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:127

`Protected` onUnmount

onUnmount(): void
Protected
Returns void
Inherited from ComponentRelation.onUnmount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:203

recohere

recohere(t): void
Parameters
- t: number
Returns void
Overrides ComponentRelation.recohere
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:48

removeComponent

removeComponent(): C
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:39

requireRecohere

requireRecohere(): void
Returns void
Inherited from ComponentRelation.requireRecohere
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:164

requireUpdate

requireUpdate(updateFlags): void
Parameters
- updateFlags: number
Returns void
Inherited from ComponentRelation.requireUpdate
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:182

resolveInlets

resolveInlets(): readonly Fastener<any, any, any>[]
Returns readonly Fastener<any, any, any>[]
Inherited from ComponentRelation.resolveInlets
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:168

set

set(component): R
Parameters
- component: C | Fastener<any, I[0], any> | LikeType<C>
Returns R
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:30

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from ComponentRelation.setAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:152

`Protected` setCoherent

setCoherent(coherent): void
Protected
Parameters
- coherent: boolean
Returns void
Inherited from ComponentRelation.setCoherent
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:162

`Protected` setCoherentTime

setCoherentTime(coherentTime): void
Protected
Parameters
- coherentTime: number
Returns void
Inherited from ComponentRelation.setCoherentTime
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:103

setComponent

setComponent(component, target?, key?): C
Parameters
- component: C | LikeType<C>
- Optional target: Component<any>
- Optional key: string
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:35

setInherits

setInherits(inherits): void
Parameters
- inherits: boolean | PropertyKey
Returns void
Inherited from ComponentRelation.setInherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:136

setIntrinsic

setIntrinsic(component): R
Parameters
- component: C | Fastener<any, I[0], any> | LikeType<C>
Returns R
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:31

toString

toString(): string
Returns string
Inherited from ComponentRelation.toString
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:207

unbindInlet

unbindInlet(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.unbindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:123

`Protected` willAttachComponent

willAttachComponent(component, target): void
Protected
Parameters
- component: C
- target: Component<any>
Returns void
Inherited from ComponentRelation.willAttachComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:36

`Protected` willBindInlet

willBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.willBindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:116

`Protected` willDetachComponent

willDetachComponent(component): void
Protected
Parameters
- component: C
Returns void
Inherited from ComponentRelation.willDetachComponent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:44

`Protected` willMount

willMount(): void
Protected
Returns void
Inherited from ComponentRelation.willMount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:193

`Protected` willSetAffinity

willSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ComponentRelation.willSetAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:154

`Protected` willSetInherits

willSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ComponentRelation.willSetInherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:138

`Protected` willUnbindInlet

willUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ComponentRelation.willUnbindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:125

`Protected` willUnmount

willUnmount(): void
Protected
Returns void
Inherited from ComponentRelation.willUnmount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:201

Interface ComponentRef<R, C, I>

Type Parameters

R = any

C extends Component<any> = Component

I extends any[] = [C | null]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly coherentTime

Readonly component

Readonly inlet

Readonly inletVersion

Readonly name

Readonly owner

Readonly version

Accessors

affinity

Returns Affinity

binds

Returns boolean

coherent

Returns boolean

componentKey

Returns string

componentType

Returns ComponentFactory<C>

derived

Returns boolean

descriptorType

Returns Proto<ComponentRefDescriptor<R, C>>

fastenerType

Returns Proto<ComponentRef<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletComponent

Returns C

inletKeys

Returns readonly PropertyKey[]

mounted

Returns boolean

observes

Returns boolean

parent

Returns ComponentRef<any, C, any>

parentComponent

Returns Component<any>

parentType

Returns Proto<any>

Methods

attachComponent

Parameters

Optional component: C | LikeType<C>

Optional target: Component<any>

Returns C

attachFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected attachInlets

Returns void

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

createComponent

Returns C

`Readonly` coherentTime

`Readonly` component

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` version

`Optional` component: C | LikeType<C>

`Optional` target: Component<any>

`Protected` attachInlets

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

`Protected` deinitComponent

`Protected` detachInlets

`Protected` didAttachComponent

`Protected` didBindInlet

`Protected` didDetachComponent

`Protected` didMount

`Protected` didSetAffinity

`Protected` didSetInherits

`Protected` didUnbindInlet

`Protected` didUnmount

`Optional` fastenerType: Proto<F>

`Optional` contextType: Proto<any>