@itd-api/crypto / Cipher

Interface: Cipher

Defined in: cipher.ts:45

Алгоритм, который прячет текст в строке.

Контракт намеренно узкий: шифр не знает ни о запросах, ни о моделях — только строка на входе и строка на выходе. Всё остальное берёт на себя плагин.

Properties

acceptsCover?

optional acceptsCover?: boolean;

Defined in: cipher.ts:55

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

По этому признаку плагин решает, допустима ли разметка spans: её смещения считаются от начала видимого текста, а видимый текст — это обложка. При false или без значения видимой части не остаётся.

---

name

name: string;

Defined in: cipher.ts:47

Имя для опции encrypt и для поля Secret.cipher.

Methods

decode()

decode(text): string | null;

Defined in: cipher.ts:59

Достаёт спрятанное. null — в строке ничего нет.

Parameters

text

string

Returns

string | null

---

encode()

encode(text, options?): string;

Defined in: cipher.ts:57

Прячет текст.

Parameters

text

string

options?

EncodeOptions

Returns

string