Skip to content

Documentation / @ember-data/tracking / index / buildSignalConfig

Function: buildSignalConfig()

ts
function buildSignalConfig(options): object;

Defined in: index.ts:89

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. Use @warp-drive/ember instead.

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

waitFor()

ts
waitFor: <K>(promise) => Promise<K>;

Type Parameters

K

K

Parameters

promise

Promise<K>

Returns

Promise<K>

willSyncFlushWatchers()

ts
willSyncFlushWatchers: () => boolean;

Returns

boolean

consumeSignal()

ts
consumeSignal(signal): void;

Parameters

signal

unknown

Returns

void

createSignal()

ts
createSignal(obj, key): unknown;

Parameters

obj

object

key

string | symbol

Returns

unknown

notifySignal()

ts
notifySignal(signal): void;

Parameters

signal

unknown

Returns

void

Deprecated

Released under the MIT License.