y5 API: Модуль y5.Strings

Функции для работы со строками.

Требует загрузки модуля Strings.

EMPTY, IoToIe, NBSP, SPACE, camelize, capitalize, contains, endsWith, escapeHTML, escapeRegexp, getCode, isBlank, isEmpty, isVoid, nl2br, normalize, normalizeSpace, plural, printf, repeat, startsWith, strip, stripTags, text2html, times, trim, unescapeHTML, words, wordsCount, conversion, stripHTML

EMPTY

y5.Strings.EMPTY -> String

Пустая строка.

IoToIe

y5.Strings.IoToIe(string) -> String — преобразованная строка

Заменяет [Ёё] на "e".

Имя аргумента	Тип	Описание
string	String	строка

Пример:

"ёж" -> "еж"

NBSP

y5.Strings.NBSP -> String

Неразрывный пробел.

SPACE

y5.Strings.SPACE -> String

Пробел.

camelize

y5.Strings.camelize(string) -> String — преобразованная строка

Переводит строку разделенную дефисами в форму camelCase.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

"foo-bar-baz" -> "fooBarBaz"

capitalize

y5.Strings.capitalize(string) -> String — преобразованная строка

Переводит первый символ строки в верхний регистр.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

"foo" -> "Foo"

contains

y5.Strings.contains(string, needle) -> Boolean — результат проверки

Проверяет, что строка содержит подстроку.

Имя аргумента	Тип	Описание
string	String	строка
needle	String	строка для поиска

Пример:

y5.Strings.contains("foobarbaz", "bar")
// -> true

y5.Strings.contains("FooBarBaz", "bar")
// -> false

endsWith

y5.Strings.endsWith(string, needle) -> Boolean — результат проверки

Проверяет, что строка оканчивается подстрокой.

Имя аргумента	Тип	Описание
string	String	строка
needle	String	строка для поиска

Пример:

y5.Strings.endsWith("foobar", "bar")
// -> true

y5.Strings.endsWith("FooBar", "bar")
// -> false

escapeHTML

y5.Strings.escapeHTML(string) -> String — преобразованная строка

Возвращает строку для вставки в HTML-код.
Используется для записи в innerHTML.
Для обратного преобразование используется y5.Strings.unescapeHTML.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

"<foo>" -> "&lt;foo&gt;"

escapeRegexp

y5.Strings.escapeRegexp(string) -> String — преобразованная строка

Экранирует в строке все символы, которые являются специальными в регулярном выражении.
Используется для вставки любой строки в регулярное выражение.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

"{2}" -> "\{2\}"

getCode

y5.Strings.getCode(code) -> String — символ

Возвращает символ по его коду.

Имя аргумента	Тип	Описание
code	Number	код символа

Пример:

65 -> "A"

isBlank

Ссылка на y5.Strings.isVoid.

y5.Strings.isBlank()

isEmpty

y5.Strings.isEmpty(string) -> Boolean — результат проверки

Проверяет строку на пустоту.

Имя аргумента	Тип	Описание
string	String	строка для проверки

isVoid

y5.Strings.isVoid(string) -> Boolean — результат проверки

Проверяет строку на пустоту или содержание только пробельных символов.

Имя аргумента	Тип	Описание
string	String	строка для проверки

Пример:

' \n\t' -> true

nl2br

y5.Strings.nl2br(string, xhtml) -> String — HTML

Заменяет символ перевода строки на тег <br>

Имя аргумента	Тип	Описание
string	String	строка
xhtml	Boolean	true -> "<br />", иначе - "<br>"

Пример:

"foo\nbar" -> "foo<br>bar"

normalize

Ссылка на y5.Strings.normalizeSpace.

y5.Strings.normalize()

normalizeSpace

y5.Strings.normalizeSpace(string) -> String — преобразованная строка

Заменяет в строке множество пробельных символов на один пробел и удаляет начальные и конечные пробельные символы.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

"   foo  \t  bar \n" -> "foo bar"

plural

y5.Strings.plural(number, forms) -> String — число с формой слова

Позволяет выводить число с разными формами слова.

Имя аргумента	Тип	Описание
number	Number	число
forms	Array	список форм слова (формы: 1, 2, 5, 0)

Пример:

var forms = ['письмо', 'письма', 'писем', 'писем нет'];
y5.Strings.plural(0, forms);
// -> 'писем нет'

y5.Strings.plural(1, forms);
// -> '1 письмо'

y5.Strings.plural(2, forms);
// -> '2 письма'

y5.Strings.plural(5, forms);
// -> '5 писем'

var forms = ['письмо', 'письма', 'писем'];
y5.Strings.plural(0, forms);
// -> '0 писем'

printf

y5.Strings.printf(format, arg1, arg2, argN) -> String — результат

Форматированный вывод данных (формат printf).

Имя аргумента	Тип	Описание
format	String	строка формата вывода
arg1	Object, Array	аргумент 1 (если массив, то он используется в качестве списка аргументов)
arg2	Object	аргумент 2
argN	Object	аргумент n

repeat

y5.Strings.repeat(string) -> String — строка повторенная n раз

Повторяет строку.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

y5.Strings.repeat("foobar", 3);
// -> "foobarfoobarfoobar"

y5.Strings.repeat("foo", 0);
// -> ""

startsWith

y5.Strings.startsWith(string, needle) -> Boolean — результат проверки

Проверяет, что строка начинается с подстроки.

Имя аргумента	Тип	Описание
string	String	строка
needle	String	строка для поиска

Пример:

y5.Strings.startsWith("foobar", "foo")
// -> true

y5.Strings.startsWith("Foobar", "foo")
// -> false

strip

Ссылка на y5.Strings.trim.

y5.Strings.strip()

stripTags

y5.Strings.stripTags(element) -> String — текстовое содержимое элемента

Выбирает из элемента текст.

Имя аргумента	Тип	Описание
element	String, HTMLElement	элемент

Пример:

// <div><i>foo</i> <b>bar</b></div>
y5.Strings.stripTags(div);
// -> "foo bar"

y5.Strings.stripTags('<i>foo</i> <b>bar</b>');
// -> "foo bar"

text2html

y5.Strings.text2html(string) -> String — HTML

Преобразовывает текст в HTML.

Имя аргумента	Тип	Описание
string	String	строка

times

Ссылка на y5.Strings.repeat.

y5.Strings.times()

trim

y5.Strings.trim(string) -> String — строка с удаленными пробелами

Удаляет начальные и конечные пробельные символы.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

"   foo  \n" -> "foo"

unescapeHTML

y5.Strings.unescapeHTML(string) -> String — преобразованная строка

Функция обратная escapeHTML.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

"&lt;foo&gt;" -> "<foo>"

words

y5.Strings.words(string) -> Array — массив слов

Возвращает массив слов из строки.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

y5.Strings.words('foo bar');
// -> ['foo', 'bar']

y5.Strings.words('');
// -> []

wordsCount

y5.Strings.wordsCount(string) -> Number — число слов

Возвращает количество слов в строке.

Имя аргумента	Тип	Описание
string	String	строка

Пример:

y5.Strings.wordsCount('foo bar');
// -> 2

conversion

Устарело, используйте y5.Strings.plural.

y5.Strings.conversion(number, forms) -> String — число с формой слова

Позволяет выводить число с разными формами слова.

Имя аргумента	Тип	Описание
number	Number	число
forms	Array	список форм слова (формы: 1, 5, 2, 0)

stripHTML

Устарело, используйте y5.Strings.stripTags.

y5.Strings.stripHTML()