Signal

Signal functions.

Classes

SignalClass

Implements Signal.

new SignalClass(property): SignalClass

Parameter	Type	Description
`property`	`Property`

Returns SignalClass.

Property	Modifier	Type
`_scalar`	`public`	`undefined` \| `Scalar`
`boolean`	`public`	`undefined` \| `boolean`
`cssString`	`public readonly`	`undefined` \| `string`
`id`	`public readonly`	`${string}.${string}`
`number`	`public`	`undefined` \| `number`
`property`	`public`	`Property`
`scalar`	`public`	`undefined` \| `Scalar`
`scalarProperty`	`public readonly`	`ScalarProperty`
`string`	`public`	`undefined` \| `string`
`subs`	`public`	`SignalFunction`[]

Methods

sub(func): Signal

Parameter	Type	Description
`func`	`SignalFunction`

Returns Signal. Implementation of Signal.sub.

unsub(func): Signal

Parameter	Type	Description
`func`	`SignalFunction`

Returns Signal. Implementation of Signal.unsub.

Interfaces

Signal

Property	Type
`boolean?`	`boolean`
`cssString?`	`string`
`id`	`${string}.${string}`
`number?`	`number`
`property`	`Property`
`scalar?`	`Scalar`
`scalarProperty`	`ScalarProperty`
`string?`	`string`
`subs`	`SignalFunction`[]

Methods

sub(func): Signal

Parameter	Type
`func`	`SignalFunction`

Returns Signal.

unsub(func): Signal

Parameter	Type
`func`	`SignalFunction`

Returns Signal.

Signaled

Property	Type
`signal`	`Signal`
`signalId?`	`${string}.${string}`
`signalOrNot?`	`Signal`

Methods

handleSignal(signal): void

Parameter	Type
`signal`	`Signal`

Returns void.

signalRemove(): boolean

Returns boolean.

Type Aliases

SignalFunction

SignalFunction: (signal) => void

Parameter	Type
`signal`	`Signal`

Returns void.

SignalId

SignalId: `${string}.${string}`

SignalRecord

SignalRecord: Record<string, Signal>

SignalScalarRecord

SignalScalarRecord: Record<SignalId, Scalar>

SignalsRecord

SignalsRecord: Record<string, SignalRecord>

Variables

SIGNAL_IDS_REGEX

const SIGNAL_IDS_REGEX: RegExp

Functions

isSignalId

isSignalId(value): value is `${string}.${string}`

Parameter	Type
`value`	`any`

Returns value is `${string}.${string}`.

signalIdFromObject

signalIdFromObject(object): SignalId

Parameter	Type
`object`	`PropertyObject`

Returns SignalId.