Skip to main content

CodeSignalContext

class CodeSignalContextTOwner extends SignalContextPossibleCodeScopeCodeScopeTOwnerimplements CodeSignalHelpersTOwner

Type Parameters

Constructors​

constructor​

public override new CodeSignalContextTOwnerinitial: PossibleCodeScopeowner: TOwnerhighlighter?: SignalValuenullCodeHighlighterunknown: CodeSignalContextTOwner

Type Parameters

Parameters

Overwrites SignalContext<PossibleCodeScope, CodeScope, TOwner>.constructor

Methods​

append​

public appendcode: string: TOwner
public appendcode: stringduration: number: ThreadGenerator
public appendduration?: number: TagGenerator

Parameters

dispose​

public dispose(): void
Inherited from SignalContext.dispose

edit​

public editduration: number = 0.6: TagGenerator

Parameters

get​

public get(): CodeScope
Inherited from SignalContext.get

getInitial​

public getInitial(): undefinedSignalValuePossibleCodeScope

Get the initial value of this signal.

Inherited from SignalContext.getInitial

getter​

public getter(): CodeScope
Inherited from SignalContext.getter

insert​

public insertpoint: CodePointcode: string: TOwner
public insertpoint: CodePointcode: stringduration: number: ThreadGenerator

Parameters

isInitial​

public isInitial(): boolean

Check if the signal is currently using its initial value.

Examples

Inherited from SignalContext.isInitial

isTweening​

public isTweening(): boolean

Is the signal undergoing a tween?

Inherited from SignalContext.isTweening

parse​

public override parsevalue: PossibleCodeScope: CodeScope

Parameters

Overwrites SignalContext.parse

prepend​

public prependcode: string: TOwner
public prependcode: stringduration: number: ThreadGenerator
public prependduration?: number: TagGenerator

Parameters

raw​

public raw(): undefinedSignalValuePossibleCodeScope

Get the raw value of this signal.

If the signal was provided with a factory function, the function itself will be returned, without invoking it.

This method can be used to create copies of signals.

Examples

Inherited from SignalContext.raw

remove​

public removerange: CodeRange: TOwner
public removerange: CodeRangeduration: number: ThreadGenerator

Parameters

replace​

public replacerange: CodeRangecode: string: TOwner
public replacerange: CodeRangecode: stringduration: number: ThreadGenerator

Parameters

reset​

public reset(): TOwner

Reset the signal to its initial value (if one has been set).

Examples

Inherited from SignalContext.reset

save​

public save(): TOwner

Compute the current value of the signal and immediately set it.

This method can be used to stop the signal from updating while keeping its current value.

Examples

Inherited from SignalContext.save

set​

public setvalue: typeof DEFAULTSignalValuePossibleCodeScope: TOwner

Parameters

Inherited from SignalContext.set

setter​

public settervalue: typeof DEFAULTSignalValuePossibleCodeScope: TOwner

Parameters

Inherited from SignalContext.setter

toPromise​

public toPromise(): PromiseCodeSignalContextTOwner
Inherited from SignalContext.toPromise

toSignal​

public override toSignal(): CodeSignalTOwner
Overwrites SignalContext.toSignal

tweener​

public override tweenervalue: SignalValuePossibleCodeScopeduration: numbertimingFunction: TimingFunction: ThreadGenerator

Parameters

Overwrites SignalContext.tweener

collectPromise​

static public collectPromiseTpromise: PromiseT: PromiseHandlenullT
static public collectPromiseTpromise: PromiseTinitialValue: T: PromiseHandleT

Type Parameters

Parameters

Inherited from SignalContext.collectPromise

consumePromises​

static public consumePromises(): PromisePromiseHandleany[]
Inherited from SignalContext.consumePromises

hasPromises​

static public hasPromises(): boolean
Inherited from SignalContext.hasPromises