module@warp-drive/core/store

Interface NotificationManager

Defined in: warp-drive-packages/core/src/store/-private/managers/notification-manager.ts:279

Hideconstructor

The NotificationManager provides the ability to subscribe to changes to Cache state.

This Feature is what allows WarpDrive to create subscriptions that work with any framework or change-notification system.

Methods

subscribe()

Call Signature

subscribe(
   cacheKey, 
   callback, 
   channel?
): object;

Defined in: warp-drive-packages/core/src/store/-private/managers/notification-manager.ts:345

Subscribe to changes for a given ResourceKey, RequestKey, or addition/removal of any resource or document.

export type CacheOperation = 'added' | 'removed' | 'updated' | 'state';

export interface NotificationCallback {
  (cacheKey: ResourceKey, notificationType: 'attributes' | 'relationships', key?: string): void;
  (cacheKey: ResourceKey, notificationType: 'errors' | 'meta' | 'identity' | 'state'): void;
  (cacheKey: ResourceKey, notificationType: NotificationType, key?: string): void;
}
export interface ResourceOperationCallback {
  // resource updates
  (cacheKey: ResourceKey, notificationType: CacheOperation): void;
}
export interface DocumentOperationCallback {
  // document updates
  (cacheKey: RequestKey, notificationType: CacheOperation): void;
}

A channel may be provided when subscribing to a ResourceKey. Its effect is that the subscription skips 'attributes'/'relationships' notifications explicitly tagged with the other channel; unscoped notifications, and notifications for all other notification types, always reach the subscriber. Subscribing 'local' and omitting the channel are the same thing. See NotificationChannel.

notify ↓ subscribe →	'local'	'remote'	omitted (= 'local')
'local'	✅	❌	✅
'remote'	❌	✅	❌
omitted	✅	✅	✅

Parameters

cacheKey

ResourceKey

callback

NotificationCallback

channel?

NotificationChannel

Returns

object

an opaque token to be used with unsubscribe

Call Signature

subscribe(cacheKey, callback): object;

Defined in: warp-drive-packages/core/src/store/-private/managers/notification-manager.ts:346

Subscribe to changes for a given ResourceKey, RequestKey, or addition/removal of any resource or document.

export type CacheOperation = 'added' | 'removed' | 'updated' | 'state';

export interface NotificationCallback {
  (cacheKey: ResourceKey, notificationType: 'attributes' | 'relationships', key?: string): void;
  (cacheKey: ResourceKey, notificationType: 'errors' | 'meta' | 'identity' | 'state'): void;
  (cacheKey: ResourceKey, notificationType: NotificationType, key?: string): void;
}
export interface ResourceOperationCallback {
  // resource updates
  (cacheKey: ResourceKey, notificationType: CacheOperation): void;
}
export interface DocumentOperationCallback {
  // document updates
  (cacheKey: RequestKey, notificationType: CacheOperation): void;
}

A channel may be provided when subscribing to a ResourceKey. Its effect is that the subscription skips 'attributes'/'relationships' notifications explicitly tagged with the other channel; unscoped notifications, and notifications for all other notification types, always reach the subscriber. Subscribing 'local' and omitting the channel are the same thing. See NotificationChannel.

notify ↓ subscribe →	'local'	'remote'	omitted (= 'local')
'local'	✅	❌	✅
'remote'	❌	✅	❌
omitted	✅	✅	✅

Parameters

cacheKey

"resource"

callback

ResourceOperationCallback

Returns

object

an opaque token to be used with unsubscribe

Call Signature

subscribe(cacheKey, callback): object;

Defined in: warp-drive-packages/core/src/store/-private/managers/notification-manager.ts:347

Subscribe to changes for a given ResourceKey, RequestKey, or addition/removal of any resource or document.

export type CacheOperation = 'added' | 'removed' | 'updated' | 'state';

export interface NotificationCallback {
  (cacheKey: ResourceKey, notificationType: 'attributes' | 'relationships', key?: string): void;
  (cacheKey: ResourceKey, notificationType: 'errors' | 'meta' | 'identity' | 'state'): void;
  (cacheKey: ResourceKey, notificationType: NotificationType, key?: string): void;
}
export interface ResourceOperationCallback {
  // resource updates
  (cacheKey: ResourceKey, notificationType: CacheOperation): void;
}
export interface DocumentOperationCallback {
  // document updates
  (cacheKey: RequestKey, notificationType: CacheOperation): void;
}

A channel may be provided when subscribing to a ResourceKey. Its effect is that the subscription skips 'attributes'/'relationships' notifications explicitly tagged with the other channel; unscoped notifications, and notifications for all other notification types, always reach the subscriber. Subscribing 'local' and omitting the channel are the same thing. See NotificationChannel.

notify ↓ subscribe →	'local'	'remote'	omitted (= 'local')
'local'	✅	❌	✅
'remote'	❌	✅	❌
omitted	✅	✅	✅

Parameters

cacheKey

| "document" | RequestKey

callback

DocumentOperationCallback

Returns

object

an opaque token to be used with unsubscribe

---

unsubscribe()

unsubscribe(token): void;

Defined in: warp-drive-packages/core/src/store/-private/managers/notification-manager.ts:382

remove a previous subscription

Parameters

token

object

Returns

void