itd-api / FeatureContext

Interface: FeatureContext

Defined in: core/features.ts:76

Доступ подключаемого модуля к клиенту.

Properties

baseUrl

readonly baseUrl: string;

Defined in: core/features.ts:78

---

clock

readonly clock: ItdClock;

Defined in: core/features.ts:80

---

featureName

readonly featureName: string;

Defined in: core/features.ts:77

---

files

readonly files: FileResolver;

Defined in: core/features.ts:83

Открывает файловый источник без правил конкретного протокола загрузки.

---

logger

readonly logger: Logger | undefined;

Defined in: core/features.ts:81

---

signal

readonly signal: AbortSignal;

Defined in: core/features.ts:79

Methods

assertActive()

assertActive(action): void;

Defined in: core/features.ts:99

Проверяет, что создавший модуль клиент ещё работает.

Parameters

action

string

Returns

void

---

connection()

connection(name): ClientConnection;

Defined in: core/features.ts:95

Окружение долговременного соединения объявленного сервиса.

Parameters

name

string

Returns

ClientConnection

---

manage()

manage(resource): () => void;

Defined in: core/features.ts:97

Регистрирует активный долгоживущий ресурс до его остановки.

Parameters

resource

ManagedClientResource

Returns

() => void

---

request()

request<T>(operation, options): Promise<T>;

Defined in: core/features.ts:91

Выполняет объявленную операцию через авторизацию, плагины, повторы и очередь клиента.

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

Type Parameters

T

T = unknown

Parameters

operation

string

options

FeatureRequestOptions

Returns

Promise<T>

---

serviceBaseUrl()

serviceBaseUrl(name): string;

Defined in: core/features.ts:93

Возвращает фактический URL объявленного сервиса с учётом настроек клиента.

Parameters

name

string

Returns

string