Swim Fastener Library

The Swim Fastener library implements observable properties.

Index

Classes

Interfaces

Variables

Type aliases

Affinity

Affinity: number

AnimatorDescriptor

AnimatorDescriptor<O, T, U, I>: ThisType<Animator<O, T, U> & I> & AnimatorInit<T, U> & Partial

Type parameters

O = unknown
T = unknown
U = T
I = {}

AnimatorState

AnimatorState<A>: A extends Animator<any, infer T, any> ? T : never

Type parameters

A: Animator<any, any>

AnimatorStateInit

AnimatorStateInit<A>: A extends Animator<any, infer T, infer U> ? T | U : never

Type parameters

A: Animator<any, any>

FastenerDescriptor

FastenerDescriptor<O, I>: ThisType<Fastener<O> & I> & FastenerInit & Partial

Type parameters

O = unknown
I = {}

FastenerFlags

FastenerFlags: number

FastenerOwner

FastenerOwner<F>: F extends Fastener<infer O> ? O : never

Type parameters

HierarchyFlags

HierarchyFlags: number

MemberAnimatorInit

MemberAnimatorInit<O, K>: O[K] extends Animator<any, infer T, infer U> ? T | U : never

Type parameters

O
K: keyof O

MemberAnimatorInitMap

MemberAnimatorInitMap<O>: {-readonly [ K in keyof O as O[K] extends Property<any, any> ? K : never]-?: MemberAnimatorInit<O, K> }

Type parameters

MemberAnimatorState

MemberAnimatorState<O, K>: O[K] extends Animator<any, infer T> ? T : never

Type parameters

O
K: keyof O

MemberAnimatorStateInit

MemberAnimatorStateInit<O, K>: O[K] extends Animator<any, any, infer U> ? U : never

Type parameters

O
K: keyof O

MemberFastener

MemberFastener<O, K, F>: MemberFasteners<O, F>[K] extends F ? MemberFasteners<O, F>[K] : never

Type parameters

O
K: keyof MemberFasteners<O, F>
F: Fastener<any> = Fastener<any>

MemberFastenerClass

MemberFastenerClass<O, K, F>: MemberFasteners<O, F>[K] extends F ? FastenerClass<MemberFasteners<O, F>[K]> : never

Type parameters

O
K: keyof MemberFasteners<O, F>
F: Fastener<any> = Fastener<any>

MemberFasteners

MemberFasteners<O, F>: {[ K in keyof O as O[K] extends F ? K : never]: O[K] }

Type parameters

O
F: Fastener<any> = Fastener<any>

MemberPropertyInit

MemberPropertyInit<O, K>: O[K] extends Property<any, infer T, infer U> ? T | U : never

Type parameters

O
K: keyof O

MemberPropertyInitMap

MemberPropertyInitMap<O>: {-readonly [ K in keyof O as O[K] extends Property ? K : never]-?: MemberPropertyInit<O, K> }

Type parameters

MemberPropertyState

MemberPropertyState<O, K>: O[K] extends Property<any, infer T> ? T : never

Type parameters

O
K: keyof O

MemberPropertyStateInit

MemberPropertyStateInit<O, K>: O[K] extends Property<any, any, infer U> ? U : never

Type parameters

O
K: keyof O

MemberProviderService

MemberProviderService<O, K>: O[K] extends Provider<any, infer S> ? S : never

Type parameters

O
K: keyof O

PropertyDescriptor

PropertyDescriptor<O, T, U, I>: ThisType<Property<O, T, U> & I> & PropertyInit<T, U> & Partial

Type parameters

O = unknown
T = unknown
U = T
I = {}

PropertyState

PropertyState: P extends Property<any, infer T> ? T : never

Type parameters

P: Property<any, any>

PropertyStateInit

PropertyStateInit: P extends Property<any, infer T, infer U> ? T | U : never

Type parameters

P: Property<any, any>

ProviderDescriptor

ProviderDescriptor<O, S, I>: ThisType<Provider<O, S> & I> & ProviderInit<S> & Partial

Type parameters

O = unknown
S = unknown
I = {}

ProviderService

ProviderService: P extends Provider<any, infer S> ? S : never

Type parameters

P: Provider<any, any>

Variables

Affinity

Affinity: { Extrinsic: number; Inherited: number; Intrinsic: number; Mask: number; Reflexive: number; Shift: number; Transient: number }

Type declaration

Readonly Extrinsic: number
Readonly Inherited: number
Readonly Intrinsic: number
Readonly Mask: number
Readonly Reflexive: number
Readonly Shift: number
Readonly Transient: number

Animator

Animator: AnimatorFactory<Animator<any, any, any>>

Const BooleanAnimator

Const BooleanProperty

Fastener

Fastener: FastenerFactory<Fastener<any>>

FastenerContext

FastenerContext: { decorate: any; decorator: any; getFastenerClass: any; getLazyFastener: any; getSuperFastenerClass: any; has: any; init: any; is: any }

Type declaration

decorate: function
- decorate(factory: FastenerFactory<Fastener<any>>, descriptor: FastenerDescriptor<unknown, {}>, target: Object, propertyKey: string | symbol): void
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:29
 Parameters
 - factory: FastenerFactory<Fastener<any>>
 - descriptor: FastenerDescriptor<unknown, {}>
 - target: Object
 - propertyKey: string | symbol
 Returns void
decorator: function
- decorator(factory: FastenerFactory<Fastener<any>>, descriptor: FastenerDescriptor<unknown, {}>): PropertyDecorator
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:30
 Parameters
 - factory: FastenerFactory<Fastener<any>>
 - descriptor: FastenerDescriptor<unknown, {}>
 Returns PropertyDecorator
getFastenerClass: function
- getFastenerClass<F_1>(contextClass: FastenerContextClass, fastenerName: string, fastenerBound: Class<F_1>): null | FastenerClass<Fastener<any>>
- getFastenerClass(contextClass: FastenerContextClass, fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | FastenerClass<Fastener<any>>
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:26
 Type parameters
 - F_1: Fastener<any, F_1>
 Parameters
 - contextClass: FastenerContextClass
 - fastenerName: string
 - fastenerBound: Class<F_1>
 Returns null | FastenerClass<Fastener<any>>
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:27
 Parameters
 - contextClass: FastenerContextClass
 - fastenerName: string
 - Optional fastenerBound: null | Class<Fastener<unknown>>
 Returns null | FastenerClass<Fastener<any>>
getLazyFastener: function
- getLazyFastener<F>(fastenerContext: FastenerContext, fastenerName: string, fastenerBound: Class<F>): null | F
- getLazyFastener(fastenerContext: FastenerContext, fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): null | Fastener<unknown>
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:24
 Type parameters
 - F: Fastener<any, F>
 Parameters
 - fastenerContext: FastenerContext
 - fastenerName: string
 - fastenerBound: Class<F>
 Returns null | F
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:25
 Parameters
 - fastenerContext: FastenerContext
 - fastenerName: string
 - Optional fastenerBound: null | Class<Fastener<unknown>>
 Returns null | Fastener<unknown>
getSuperFastenerClass: function
- getSuperFastenerClass(contextClass: FastenerContextClass, fastenerName: string, fastenerBound?: null | Class<Fastener<unknown>>): FastenerClass<Fastener<any>>
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:28
 Parameters
 - contextClass: FastenerContextClass
 - fastenerName: string
 - Optional fastenerBound: null | Class<Fastener<unknown>>
 Returns FastenerClass<Fastener<any>>
has: function
- has<K>(object: unknown, key: K): object is Required<Pick<FastenerContext, K>>
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:32
 Type parameters
 - K: keyof FastenerContext
 Parameters
 - object: unknown
 - key: K
 Returns object is Required<Pick<FastenerContext, K>>
init: function
- init(fastenerContext: FastenerContext): void
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:31
  Parameters
  - fastenerContext: FastenerContext
  Returns void
is: function
- is(object: unknown): object is FastenerContext
- - Defined in swim-runtime-js/swim-core-js/@swim/fastener/lib/main/fastener/FastenerContext.d.ts:33
  Parameters
  - object: unknown
  Returns object is FastenerContext

Const NumberAnimator

Const NumberProperty

Property

Property: PropertyFactory<Property<any, any, any>>

Provider

Provider: ProviderFactory<Provider<any, any>>

Const StringAnimator

StringAnimator: AnimatorFactory<Animator<any, string | null | undefined, string | null | undefined>>

Const StringProperty

StringProperty: PropertyFactory<Property<any, string | null | undefined, string | null | undefined>>

Swim Fastener Library

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

Affinity

AnimatorDescriptor

Type parameters

O = unknown

T = unknown

U = T

I = {}

AnimatorState

Type parameters

A: Animator<any, any>

AnimatorStateInit

Type parameters

A: Animator<any, any>

FastenerDescriptor

Type parameters

O = unknown

I = {}

FastenerFlags

FastenerOwner

Type parameters

F

HierarchyFlags

MemberAnimatorInit

Type parameters

O

K: keyof O

MemberAnimatorInitMap

Type parameters

O

MemberAnimatorState

Type parameters

O

K: keyof O

MemberAnimatorStateInit

Type parameters

O

K: keyof O

MemberFastener

Type parameters

O

K: keyof MemberFasteners<O, F>

F: Fastener<any> = Fastener<any>

MemberFastenerClass

Type parameters

O

K: keyof MemberFasteners<O, F>

F: Fastener<any> = Fastener<any>

MemberFasteners

Type parameters

O

F: Fastener<any> = Fastener<any>

MemberPropertyInit

Type parameters

O

K: keyof O

MemberPropertyInitMap

Type parameters

O

MemberPropertyState

Type parameters

O

K: keyof O

MemberPropertyStateInit

Type parameters

O

K: keyof O

MemberProviderService

Type parameters

O

K: keyof O

PropertyDescriptor

Type parameters

O = unknown