@itd-api/crypto / CryptPlugin

Interface: CryptPlugin

Defined in: packages/crypto/src/plugin.ts:45

Один объект, совместимый и с системой плагинов клиента, и с обработчиками событий.

Example

const crypto = crypt();
itd.use(crypto);
itd.notifications.events.use(crypto);

Extends

• ClientPlugin.EventMiddlewareObject<EventContext>

Properties

after?

optional after?: readonly string[];

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

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

Inherited from

ClientPlugin.after

---

before?

optional before?: readonly string[];

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

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

Inherited from

ClientPlugin.before

---

conflicts?

optional conflicts?: readonly string[];

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

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

Inherited from

ClientPlugin.conflicts

---

name

name: string;

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

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

Inherited from

ClientPlugin.name

---

requires?

optional requires?: readonly string[];

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

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

Inherited from

ClientPlugin.requires

Methods

install()

install(api): void | PluginTeardown;

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

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

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

Parameters

api

PluginApi

Returns

void | PluginTeardown

Inherited from

ClientPlugin.install

---

middleware()

middleware(): EventMiddleware<EventContext<unknown, unknown, unknown>>;

Defined in: src/events/middleware.ts:16

Returns

EventMiddleware<EventContext<unknown, unknown, unknown>>

Inherited from

EventMiddlewareObject.middleware