@itd-api/cache / CachePlugin

Interface: CachePlugin

Defined in: packages/cache/src/plugin.ts:47

Плагин и управление созданным им хранилищем.

Extends

• ClientPlugin

Properties

after?

optional after?: readonly string[];

Defined in: src/core/plugins/contracts.ts:168

Имена плагинов, внутри которых должны стоять оба вида расширений этого плагина.

Inherited from

ClientPlugin.after

---

before?

optional before?: readonly string[];

Defined in: src/core/plugins/contracts.ts:166

Имена плагинов, снаружи которых должны стоять оба вида расширений этого плагина.

Inherited from

ClientPlugin.before

---

conflicts?

optional conflicts?: readonly string[];

Defined in: src/core/plugins/contracts.ts:164

Несовместимые плагины. Достаточно объявить конфликт с одной стороны.

Inherited from

ClientPlugin.conflicts

---

name

name: string;

Defined in: src/core/plugins/contracts.ts:160

Имя плагина. Должно быть уникальным: повторное подключение — ошибка.

Inherited from

ClientPlugin.name

---

requires?

optional requires?: readonly string[];

Defined in: src/core/plugins/contracts.ts:162

Плагины, которые обязаны быть подключены раньше этого.

Inherited from

ClientPlugin.requires

---

size

readonly size: number;

Defined in: packages/cache/src/plugin.ts:49

Количество готовых ответов во всех разделах кэша.

Methods

attachNotificationEvents()

attachNotificationEvents<C>(stream): Unsubscribe;

Defined in: packages/cache/src/plugin.ts:60

Подключает инвалидацию к нормализованным событиям уведомлений.

Удаляет сохранённые список и счётчик, затем отслеживает обновления через промежуточный обработчик. Подключайте его до обработчиков, способных остановить цепочку.

Type Parameters

C

C extends NotificationEventContext

Parameters

stream

NotificationEvents<C>

Returns

Unsubscribe

---

clear()

clear(): void;

Defined in: packages/cache/src/plugin.ts:51

Удаляет все ответы и не даёт выполняющимся запросам вернуть устаревший результат.

Returns

void

---

install()

install(api): void | PluginTeardown;

Defined in: src/core/plugins/contracts.ts:177

Устанавливает плагин.

Может вернуть функцию освобождения ресурсов. Она вызывается при unuse() или окончательном dispose() клиента и может быть асинхронной. Сам install() синхронный: регистрация расширений завершается до того, как use() вернёт управление.

Parameters

api

PluginApi

Returns

void | PluginTeardown

Inherited from

ClientPlugin.install

---

invalidate()

invalidate(...operations): void;

Defined in: packages/cache/src/plugin.ts:53

Удаляет все варианты названных операций во всех подключённых клиентах.

Parameters

operations

...OperationId[]

Returns

void