CodeSignalContext

class CodeSignalContextTOwner extends SignalContextPossibleCodeScopeCodeScopeTOwnerimplements CodeSignalHelpersTOwner

Type Parameters

• TOwner

Constructors​

constructor​

public override new CodeSignalContextinitial: SignalValuePossibleCodeScopeowner: TOwnerhighlighter?: SignalValuenullCodeHighlighterunknown: CodeSignalContextTOwner

Parameters

• initial: SignalValuePossibleCodeScope
• owner: TOwner
• highlighter?: SignalValuenullCodeHighlighterunknown

Methods​

append​

public appendcode: CodeTag: TOwner

public appendcode: CodeTagduration: number: ThreadGenerator

public appendduration?: number: TagGenerator

Parameters

• code: CodeTag

dispose​

public dispose(): void

edit​

public editduration: number = 0.6: TagGenerator

Parameters

• duration: number = 0.6

get​

public get(): CodeScope

getInitial​

public getInitial(): undefinedSignalValuePossibleCodeScope

Get the initial value of this signal.

getter​

public getter(): CodeScope

insert​

public insertpoint: CodePointcode: CodeTag: TOwner

public insertpoint: CodePointcode: CodeTagduration: number: ThreadGenerator

public insertpoint: CodePointduration?: number: TagGenerator

Parameters

• point: CodePoint
• code: CodeTag

isInitial​

public isInitial(): boolean

Check if the signal is currently using its initial value.

Examples

isTweening​

public isTweening(): boolean

Is the signal undergoing a tween?

parse​

public override parsevalue: PossibleCodeScope: CodeScope

Parameters

• value: PossibleCodeScope

prepend​

public prependcode: CodeTag: TOwner

public prependcode: CodeTagduration: number: ThreadGenerator

public prependduration?: number: TagGenerator

Parameters

• code: CodeTag

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

remove​

public removerange: CodeRange: TOwner

public removerange: CodeRangeduration: number: ThreadGenerator

Parameters

• range: CodeRange

replace​

public replacerange: CodeRangecode: CodeTag: TOwner

public replacerange: CodeRangecode: CodeTagduration: number: ThreadGenerator

public replacerange: CodeRangeduration?: number: TagGenerator

Parameters

• range: CodeRange
• code: CodeTag

reset​

public reset(): TOwner

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

Examples

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

set​

public setvalue: typeof DEFAULTSignalValuePossibleCodeScope: TOwner

Parameters

• value: typeof DEFAULTSignalValuePossibleCodeScope

setter​

public settervalue: typeof DEFAULTSignalValuePossibleCodeScope: TOwner

Parameters

• value: typeof DEFAULTSignalValuePossibleCodeScope

toPromise​

public toPromise(): PromiseCodeSignalContextTOwner

toSignal​

public override toSignal(): CodeSignalTOwner

tweener​

public override tweenervalue: SignalValuePossibleCodeScopeduration: numbertimingFunction: TimingFunction: ThreadGenerator

Parameters

• value: SignalValuePossibleCodeScope
• duration: number
• timingFunction: TimingFunction

collectPromise​

static public collectPromisepromise: PromiseT: PromiseHandlenullT

static public collectPromisepromise: PromiseTinitialValue: T: PromiseHandleT

Parameters

• promise: PromiseT

consumePromises​

static public consumePromises(): PromisePromiseHandleany[]

hasPromises​

static public hasPromises(): boolean