Skip to content

TEXT-ALIGN-RU.md

Latest commit

 

History

History
110 lines (81 loc) · 7.91 KB

TEXT-ALIGN-RU.md

File metadata and controls

110 lines (81 loc) · 7.91 KB
Raw

api: Главная | Readme

CONSOLE-LAYOUT

# TEXT-LEFT

Утилита, которая позволяет сформировать строку определенной длины и разместить в данной области текст слева. Если текст не помещается в длину строки, то текст обрезается до заданной длины.

import { textLeft } from 'console-layout';

const context0 = textLeft('01234', 10); // |01234     |
console.log(`|${context0}|`);

const context1 = textLeft('0123456789', 10); // |0123456789|
console.log(`|${context1}|`);

const context2 = textLeft('0123456789', 10, 1); // | 012345678|
console.log(`|${context2}|`);

const context3 = textLeft('0123456789', 10, 1, 1); // | 01234567 |
console.log(`|${context3}|`);
Аргумент Название Тип Обязательность По умолчанию Описание
1 context string | number true - текст, который надо разместить, в строке
2 maxRowLength number true - формирует строку определенной длины, на которой размещается текст. Если текст не помещаетcя, то обрезается результат до указанной длины.
3 indentBefore number false 0 дополнительный отступ перед текстом
4 indentAfter number false 0 дополнительный отступ после текста

# TEXT-RIGHT

Утилита, которая позволяет сформировать строку определенной длины и разместить в данной области текст справа. Если текст не помещается в длину строки, то текст обрезается до заданной длины.

import { textRight } from 'console-layout';

const context0 = textRight('01234', 10); // |     01234|
console.log(`|${context0}|`);

const context1 = textRight('0123456789', 10); // |0123456789|
console.log(`|${context1}|`);

const context2 = textRight('0123456789', 10, 1); // | 012345678|
console.log(`|${context2}|`);

const context3 = textRight('0123456789', 10, 1, 1); // | 01234567 |
console.log(`|${context3}|`);
Аргумент Название Тип Обязательность По умолчанию Описание
1 context string | number true - текст, который надо разместить, в строке
2 maxRowLength number true - формирует строку определенной длины, на которой размещается текст. Если текст не помещаетcя, то обрезается результат до указанной длины.
3 indentBefore number false 0 дополнительный отступ перед текстом
4 indentAfter number false 0 дополнительный отступ после текста

# TEXT-CENTER

Утилита, которая позволяет сформировать строку определенной длины и разместить в данной области текст по центру. Если текст не помещается в длину строки, то текст обрезается до заданной длины.

import { textCenter } from 'console-layout';

const context0 = textCenter('01234', 10); // |   01234  |
console.log(`|${context0}|`);

const context1 = textCenter('0123456789', 10); // |0123456789|
console.log(`|${context1}|`);

const context2 = textCenter('0123456789', 10, 1); // | 012345678|
console.log(`|${context2}|`);

const context3 = textCenter('0123456789', 10, 1, 1); // | 01234567 |
console.log(`|${context3}|`);
Аргумент Название Тип Обязательность По умолчанию Описание
1 context string | number true - текст, который надо разместить, в строке
2 maxRowLength number true - формирует строку определенной длины, на которой размещается текст. Если текст не помещаетcя, то обрезается результат до указанной длины.
3 indentBefore number false 0 дополнительный отступ перед текстом
4 indentAfter number false 0 дополнительный отступ после текста

# Документация