1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
{{alias}}( str, len[, options] )
Pads a `string` such that the padded `string` has length `len`.
Any padding which does not evenly divide available space is trimmed such
that the returned string length is always `len`.
If `len < str.length`, the input string is trimmed.
Parameters
----------
str: string
Input string.
len: integer
Output string length.
options: Object (optional)
Options.
options.lpad: string (optional)
String used to left pad.
options.rpad: string (optional)
String used to right pad.
options.centerRight: boolean (optional)
Boolean indicating whether to center right in the event of a tie.
Default: `false` (i.e., center left).
Returns
-------
out: string
Padded string.
Examples
--------
// Standard usage:
> var out = {{alias}}( 'a', 5 )
'a '
// Left pad:
> out = {{alias}}( 'a', 10, { 'lpad': 'b' })
'bbbbbbbbba'
// Right pad:
> out = {{alias}}( 'a', 12, { 'rpad': 'b' })
'abbbbbbbbbbb'
// Center an input string:
> var opts = { 'lpad': 'a', 'rpad': 'c' };
> out = {{alias}}( 'b', 11, opts )
'aaaaabccccc'
// Left center:
> opts.centerRight = false;
> out = {{alias}}( 'b', 10, opts )
'aaaabccccc'
// Right center:
> opts.centerRight = true;
> out = {{alias}}( 'b', 10, opts )
'aaaaabcccc'
// Output string always length `len`:
> opts = { 'lpad': 'boop', 'rpad': 'woot' };
> out = {{alias}}( 'beep', 10, opts )
'boobeepwoo'
// Pad right, trim right:
> out = {{alias}}( 'beep', 2 )
'be'
// Pad left, trim left:
> opts = { 'lpad': 'b' };
> out = {{alias}}( 'beep', 2, opts )
'ep'
// Pad both, trim both:
> opts = { 'lpad': '@', 'rpad': '!' };
> out = {{alias}}( 'beep', 2, opts )
'ee'
// Pad both, trim both starting from left:
> out = {{alias}}( 'abcdef', 3, opts )
'cde'
// Pad both, trim both starting from right:
> opts.centerRight = true;
> out = {{alias}}( 'abcdef', 3, opts )
'bcd'
See Also
--------
|
