YString

YString

Данная страница посвящена модулю Ystring. Модуль является оберткой над строковыми примитивами. С его помощью открываются возможности для манипуляции над строкой, которые были ранее недоступны. К примеру, вы можете вставить подстроку в исходную строку или отзеркалить её. Этот модуль может быть удобным инструментом для редактирования текста и его анализа и генерации.

Рассмотрим пример создания строки:

const ystr = new YString('оборачиваемая строка');

Значение ystr обернуто в класс Ystring. Переданная в качестве первого аргумента строка сохраняется в качестве свойства в обертке с модификатором доступа protected - это сделано для того, чтобы значение не могло быть изменено чем-либо за пределами обертки.

Прекрасно понятно, что в JS на данный момент нет такого модификатора доступа, в связи с чем изменить свойство все же можно, однако, с имеющимся в JSDOc модификатором, открывается возможность скрыть свойство от глаз пользователя, что уже делает данное поле более безопасным.

Изменения обернутого значения осуществляется через методы класса обертки. В большинстве случаев, эти методы возвращают в качестве результата саму обертку. Лишь некоторые методы, чьё предназначение сводится к получению каких-либо другие данных от обертки, могут вернуть в качестве результата объект отличный от обертки или обернутое её значение. К таким методам относится метод get.

get()

// Сохраним текущее состояние обертки в переменную str.
const str = ystr.get();

Метод get позволяет получить текущее состояние обернутой строки. Помимо прочего, он принимает на вход один параметр style:boolean. Данный параметр указывает на необходимость вернуть не только преобразованный текст, но и примененные к нему стили.