Interface ComponentRefClass<F>

Type Parameters

F extends ComponentRef<any, any, any> = ComponentRef

Hierarchy

ComponentRelationClass<F>
- ComponentRefClass

ComponentRefClass<F2>(template): FastenerDecorator<F2>
Type Parameters
- F2 extends ComponentRef<any, any, any>
Parameters
- template: FastenerTemplate<F2>
Returns FastenerDecorator<F2>
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:31

Index

Methods

construct create define extend getter refine specialize tryComponent

Methods

`Protected` construct

construct(fastener, owner): F
Protected
Parameters
- fastener: F
- owner: F extends Fastener<R, any, any>
  ? R
  : never
Returns F
Inherited from ComponentRelationClass.construct
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:34

create

create(owner): F
Parameters
- owner: F extends Fastener<R, any, any>
  ? R
  : never
Returns F
Inherited from ComponentRelationClass.create
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:32

define

define<F2>(className, template, extendsClass?): FastenerClass<F2>
Type Parameters
- F2 extends ComponentRef<any, any, any>
Parameters
- className: PropertyKey
- template: FastenerTemplate<F2>
- Optional extendsClass: FastenerClass<F>
Returns FastenerClass<F2>
Inherited from ComponentRelationClass.define
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:44

extend

extend<F2, C>(className, template, classTemplate?): C
Type Parameters
- F2 extends ComponentRef<any, any, any>
- C extends FastenerClass<any> = FastenerClass<F2>
Parameters
- className: PropertyKey
- template: FastenerTemplate<F2>
- Optional classTemplate: FastenerClassTemplate<C>
Returns C
Inherited from ComponentRelationClass.extend
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:43

getter

getter<F2>(): F2
Dummy getter function that always throws an exception. Used as a stand-in for decorated fastener getters, whose implementation is injected by the decorator.
Type Parameters
- F2 extends ComponentRef<any, any, any>
Returns F2
Inherited from ComponentRelationClass.getter
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:50

refine

refine(fastenerClass): void
Parameters
- fastenerClass: FastenerClass<Fastener<any, any, any>>
Returns void
Inherited from ComponentRelationClass.refine
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:42

specialize

specialize(template): FastenerClass<F>
Parameters
- template: F extends {
          descriptorType?: Proto<D>;
      }
      ? D
      : never
Returns FastenerClass<F>
Inherited from ComponentRelationClass.specialize
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:39

tryComponent

tryComponent<R, K, F>(owner, fastenerName): F extends {
        component: C;
    }
    ? C
    : never
Type Parameters
- R
- K extends string | number | symbol
- F = R[K]
Parameters
- owner: R
- fastenerName: K
Returns F extends {
        component: C;
    }
    ? C
    : never
- Defined in swim-core/swim-component/lib/main/ComponentRef.d.ts:15

Generated using TypeDoc