Skip to content

Documentation / @ember-data/tracking / buildSignalConfig

ts
function buildSignalConfig(options): object;

Defined in: index.ts:86

deprecated

Creates a signal configuration object for WarpDrive that integrates with Ember's reactivity system. This will be automatically imported and registered by @ember-data/store if the deprecation has not been resolved.

This function should not be called directly in your application code and this package is deprecated entirely, see the package overview for more details.

Parameters

options

wellknown

{ Array: string | symbol; }

wellknown.Array

string | symbol

Returns

object

createMemo()

ts
createMemo: <F>(object, key, fn) => () => F;

Type Parameters

F

F

Parameters

object

object

key

string | symbol

fn

() => F

Returns

ts
(): F;
Returns

F

willSyncFlushWatchers()

ts
willSyncFlushWatchers: () => boolean;

Returns

boolean

consumeSignal()

ts
consumeSignal(signal): void;

Parameters

signal

Tag | [Tag, Tag, Tag]

Returns

void

createSignal()

ts
createSignal(obj, key): Tag | readonly [Tag, Tag, Tag];

Parameters

obj

object

key

string | symbol

Returns

Tag | readonly [Tag, Tag, Tag]

notifySignal()

ts
notifySignal(signal): void;

Parameters

signal

Tag | [Tag, Tag, Tag]

Returns

void

Deprecated

Released under the MIT License.