itd-api / MarkupBuilder

Interface: MarkupBuilder

Defined in: builders/markup.ts:64

Неизменяемый билдер текста с разметкой.

Каждый метод дописывает фрагмент и сам считает offset и length в единицах UTF-16 — именно такие индексы использует JavaScript-редактор сайта.

Implements

• ItdBuilder<TextMarkup>

Methods

bold()

bold(content): MarkupBuilder;

Defined in: builders/markup.ts:166

Parameters

content

MarkupContent

Returns

MarkupBuilder

---

build()

build(): TextMarkup;

Defined in: builders/markup.ts:194

Собирает и проверяет результат.

Returns

TextMarkup

Throws

если нарушены требования к данным

Implementation of

ItdBuilder.build

---

hashtag()

hashtag(tag): MarkupBuilder;

Defined in: builders/markup.ts:141

Дописывает #хэштег и сохраняет имя без решётки в tag.

Parameters

tag

string

Returns

MarkupBuilder

---

italic()

italic(content): MarkupBuilder;

Defined in: builders/markup.ts:170

Parameters

content

MarkupContent

Returns

MarkupBuilder

---

link()

link(content, url?): MarkupBuilder;

Defined in: builders/markup.ts:158

Дописывает ссылку.

Для строки адрес по умолчанию становится и текстом ссылки. Вложенному форматированному фрагменту URL нужно передать явно.

Parameters

content

MarkupContent

url?

string

Returns

MarkupBuilder

---

mention()

mention(username): MarkupBuilder;

Defined in: builders/markup.ts:147

Дописывает @username и сохраняет имя пользователя в username.

Parameters

username

string

Returns

MarkupBuilder

---

monospace()

monospace(content): MarkupBuilder;

Defined in: builders/markup.ts:186

Parameters

content

MarkupContent

Returns

MarkupBuilder

---

newline()

newline(count?): MarkupBuilder;

Defined in: builders/markup.ts:83

Дописывает переводы строк.

Parameters

count?

number = 1

Returns

MarkupBuilder

---

quote()

quote(content): MarkupBuilder;

Defined in: builders/markup.ts:190

Parameters

content

MarkupContent

Returns

MarkupBuilder

---

span()

span(value, span): MarkupBuilder;

Defined in: builders/markup.ts:122

Дописывает фрагмент с произвольным типом разметки.

Вложенный билдер позволяет форматировать часть фрагмента дополнительным стилем. Для нескольких стилей на всём фрагменте используйте styled.

Parameters

value

MarkupContent

span

MarkupSpan

Returns

MarkupBuilder

---

spoiler()

spoiler(content): MarkupBuilder;

Defined in: builders/markup.ts:182

Parameters

content

MarkupContent

Returns

MarkupBuilder

---

strike()

strike(content): MarkupBuilder;

Defined in: builders/markup.ts:178

Parameters

content

MarkupContent

Returns

MarkupBuilder

---

styled()

styled(value, ...types): MarkupBuilder;

Defined in: builders/markup.ts:132

Дописывает фрагмент с несколькими стилями на одном диапазоне.

Для link, которому нужен url, используйте link; произвольные spans с метаданными можно объединять через вложенные вызовы span.

Parameters

value

MarkupContent

types

...SpanType[]

Returns

MarkupBuilder

---

text()

text(value): MarkupBuilder;

Defined in: builders/markup.ts:78

Дописывает обычный текст без разметки.

Parameters

value

string

Returns

MarkupBuilder

---

toJSON()

toJSON(): TextMarkup;

Defined in: builders/markup.ts:198

Чтобы билдер корректно вёл себя внутри JSON.stringify.

Returns

TextMarkup

Implementation of

ItdBuilder.toJSON

---

underline()

underline(content): MarkupBuilder;

Defined in: builders/markup.ts:174

Parameters

content

MarkupContent

Returns

MarkupBuilder