Interface Timer<R>

Type Parameters

R = any

Hierarchy

Fastener<R>
- Timer

Timer(): void
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:14

Index

Properties

coherentTime deadline delay inlet inletVersion name owner version

Accessors

affinity binds coherent derived descriptorType elapsed fastenerType inheritName inherits inletKeys mounted parent parentType remaining scheduled

Properties

`Readonly` coherentTime

coherentTime: number

`Readonly` deadline

deadline: number

`Readonly` delay

delay: number

`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 Fastener.affinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:146

binds

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

coherent

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

derived

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

descriptorType

get descriptorType(): Proto<TimerDescriptor<R>>
Returns Proto<TimerDescriptor<R>>
Overrides Fastener.descriptorType
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:16

elapsed

get elapsed(): number
Returns number
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:25

fastenerType

get fastenerType(): Proto<Timer<any>>
Returns Proto<Timer<any>>
Overrides Fastener.fastenerType
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:18

inheritName

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

inherits

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

inletKeys

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

mounted

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

parent

get parent(): Fastener<any, any, any>
Returns Fastener<any, any, any>
Inherited from Fastener.parent
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:108

parentType

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

remaining

get remaining(): number
Returns number
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:26

scheduled

get scheduled(): boolean
Returns boolean
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:27

Methods

attachFastener

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

`Protected` attachInlets

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

bindInlet

bindInlet<K, IK>(inlet, key): void
Type Parameters
- K extends keyof [any]
- IK extends any
Parameters
- inlet: Fastener<any, IK, any>
- key: IK
Returns void
Inherited from Fastener.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 Fastener.bindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:114

cancel

cancel(): void
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:37

`Protected` clearTimeout

clearTimeout(timeoutId): void
Protected
Parameters
- timeoutId: unknown
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:57

debounce

debounce(delay?): void
Parameters
- Optional delay: number
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:30

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from Fastener.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 Fastener.decohereFastener
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:180

`Protected` detachInlets

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

`Protected` didBindInlet

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

`Protected` didCancel

didCancel(): void
Protected
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:43

`Protected` didExpire

didExpire(): void
Protected
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:51

`Protected` didMount

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

`Protected` didSchedule

didSchedule(delay): void
Protected
Parameters
- delay: number
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:36

`Protected` didSetAffinity

didSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from Fastener.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 Fastener.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 Fastener.didUnbindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:129

`Protected` didUnmount

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

`Protected` fire

fire(): void
Protected
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:20

get

get(): any
Returns any
Inherited from Fastener.get
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:159

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 Fastener.getFastener
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:174

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 Fastener.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 Fastener.getTransition
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:184

hasAffinity

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

`Protected` incrementVersion

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

`Protected` init

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

initDelay

initDelay(): number
Returns number
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:21

`Protected` onBindInlet

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

`Protected` onCancel

onCancel(): void
Protected
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:41

`Protected` onExpire

onExpire(): void
Protected
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:49

`Protected` onMount

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

`Protected` onSchedule

onSchedule(delay): void
Protected
Parameters
- delay: number
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:34

`Protected` onSetAffinity

onSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from Fastener.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 Fastener.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 Fastener.onUnbindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:127

`Protected` onUnmount

onUnmount(): void
Protected
Returns void
Overrides Fastener.onUnmount
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:59

recohere

recohere(t): void
Parameters
- t: number
Returns void
Inherited from Fastener.recohere
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:165

requireRecohere

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

requireUpdate

requireUpdate(updateFlags): void
Parameters
- updateFlags: number
Returns void
Inherited from Fastener.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 Fastener.resolveInlets
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:168

schedule

schedule(delay?): void
Parameters
- Optional delay: number
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:28

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from Fastener.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 Fastener.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 Fastener.setCoherentTime
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:103

setDelay

setDelay(delay): void
Parameters
- delay: number
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:23

setInherits

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

`Protected` setTimeout

setTimeout(callback, delay): unknown
Protected
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
- delay: number
Returns unknown
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:55

throttle

throttle(delay?): void
Parameters
- Optional delay: number
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:29

toString

toString(): string
Returns string
Inherited from Fastener.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 Fastener.unbindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:123

`Protected` willBindInlet

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

`Protected` willCancel

willCancel(): void
Protected
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:39

`Protected` willExpire

willExpire(): void
Protected
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:47

`Protected` willMount

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

`Protected` willSchedule

willSchedule(delay): void
Protected
Parameters
- delay: number
Returns void
- Defined in swim-core/swim-component/lib/main/Timer.d.ts:32

`Protected` willSetAffinity

willSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from Fastener.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 Fastener.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 Fastener.willUnbindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:125

`Protected` willUnmount

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

Generated using TypeDoc