22< html >
33< head >
44 < meta charset ="utf-8 " />
5- < title > @thebespokepixel/string 0.5.5 | Documentation</ title >
5+ < title > @thebespokepixel/string 0.5.6 | Documentation</ title >
6+ < meta name ='description ' content ='Esoteric string formatting '>
67 < meta name ="viewport " content ="width=device-width,initial-scale=1 ">
78 < link href ="assets/css/ace.min.css " rel ="stylesheet ">
89 < link href ="assets/fonts/TypoPRO-Hack/TypoPRO-Hack.css " type ="text/css " rel ="stylesheet " />
910 < link href ="assets/fonts/TypoPRO-FiraSans/TypoPRO-FiraSans.css " type ="text/css " rel ="stylesheet " />
1011 < link href ="assets/css/style.css " type ="text/css " rel ="stylesheet " />
11- < meta name ='description ' content ='Esoteric string formatting '>
1212</ head >
1313< body class ='documentation m0 '>
1414 < div class ="flex ">
1515 < div id ='split-left ' class ='overflow-auto fs0 height-viewport-100 sidebar '>
1616 < div class ='py1 px2 '>
1717 < h3 class ="m0 no-anchor "> @thebespokepixel/string</ h3 >
18- < div class ="mb1 "> < code > 0.5.5 </ code > </ div >
18+ < div class ="mb1 "> < code > 0.5.6 </ code > </ div >
1919 < input
2020 placeholder ="Filter "
2121 id ="filter-input "
@@ -271,7 +271,7 @@ <h3 class='left m0 panel-title' id='constructor'>
271271 </ h3 >
272272
273273
274- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L13-L15 '
> 274+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L13-L15 '
> 275275 < span > src/index.js</ span >
276276 </ a >
277277
@@ -281,9 +281,7 @@ <h3 class='left m0 panel-title' id='constructor'>
281281 < p > Contruct a BespokeString instance.</ p >
282282
283283
284-
285- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> constructor(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > )</ div >
286-
284+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> constructor(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > )</ div >
287285
288286
289287
@@ -341,7 +339,7 @@ <h3 class='left m0 panel-title' id='pad'>
341339 </ h3 >
342340
343341
344- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L51-L55 '
> 342+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L51-L55 '
> 345343 < span > src/index.js</ span >
346344 </ a >
347345
@@ -351,9 +349,7 @@ <h3 class='left m0 panel-title' id='pad'>
351349 < p > Pad the contents.</ p >
352350
353351
354-
355- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> pad(length: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number "> Number</ a > , char: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → BespokeString</ div >
356-
352+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> pad(length: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number "> Number</ a > , char: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → BespokeString</ div >
357353
358354
359355
@@ -430,7 +426,7 @@ <h3 class='left m0 panel-title' id='tosub'>
430426 </ h3 >
431427
432428
433- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L61-L63 '
> 429+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L61-L63 '
> 434430 < span > src/index.js</ span >
435431 </ a >
436432
@@ -440,9 +436,7 @@ <h3 class='left m0 panel-title' id='tosub'>
440436 < p > Transform the contents to subscript characters.</ p >
441437
442438
443-
444- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> toSub() → BespokeString</ div >
445-
439+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> toSub() → BespokeString</ div >
446440
447441
448442
@@ -494,7 +488,7 @@ <h3 class='left m0 panel-title' id='tosuper'>
494488 </ h3 >
495489
496490
497- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L69-L71 '
> 491+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L69-L71 '
> 498492 < span > src/index.js</ span >
499493 </ a >
500494
@@ -504,9 +498,7 @@ <h3 class='left m0 panel-title' id='tosuper'>
504498 < p > Transform the contents to superscript characters.</ p >
505499
506500
507-
508- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> toSuper() → BespokeString</ div >
509-
501+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> toSuper() → BespokeString</ div >
510502
511503
512504
@@ -558,7 +550,7 @@ <h3 class='left m0 panel-title' id='asemoji'>
558550 </ h3 >
559551
560552
561- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L79-L82 '
> 553+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L79-L82 '
> 562554 < span > src/index.js</ span >
563555 </ a >
564556
@@ -569,9 +561,7 @@ <h3 class='left m0 panel-title' id='asemoji'>
569561< p > Totally naïve implentation right now, just pad wide emoji chars with a space.</ p >
570562
571563
572-
573- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> asEmoji() → BespokeString</ div >
574-
564+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> asEmoji() → BespokeString</ div >
575565
576566
577567
@@ -623,7 +613,7 @@ <h3 class='left m0 panel-title' id='inbox'>
623613 </ h3 >
624614
625615
626- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L89-L106 '
> 616+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L89-L106 '
> 627617 < span > src/index.js</ span >
628618 </ a >
629619
@@ -633,9 +623,7 @@ <h3 class='left m0 panel-title' id='inbox'>
633623 < p > Print the content as a graphic box.</ p >
634624
635625
636-
637- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> inBox(options: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object "> Object</ a > ) → BespokeString</ div >
638-
626+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> inBox(options: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object "> Object</ a > ) → BespokeString</ div >
639627
640628
641629
@@ -702,7 +690,7 @@ <h3 class='left m0 panel-title' id='bespokestring'>
702690 </ h3 >
703691
704692
705- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L122-L124 '
> 693+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L122-L124 '
> 706694 < span > src/index.js</ span >
707695 </ a >
708696
@@ -712,9 +700,7 @@ <h3 class='left m0 panel-title' id='bespokestring'>
712700 < p > Helper method for creating a BespokeString instance</ p >
713701
714702
715-
716- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> bespokeString(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → BespokeString</ div >
717-
703+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> bespokeString(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → BespokeString</ div >
718704
719705
720706
@@ -780,7 +766,7 @@ <h3 class='left m0 panel-title' id='pad'>
780766 </ h3 >
781767
782768
783- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L133-L135 '
> 769+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L133-L135 '
> 784770 < span > src/index.js</ span >
785771 </ a >
786772
@@ -790,9 +776,7 @@ <h3 class='left m0 panel-title' id='pad'>
790776 < p > Helper method for padding a string.</ p >
791777
792778
793-
794- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> pad(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > , length: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number "> Number</ a > , char: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
795-
779+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> pad(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > , length: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number "> Number</ a > , char: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
796780
797781
798782
@@ -876,7 +860,7 @@ <h3 class='left m0 panel-title' id='box'>
876860 </ h3 >
877861
878862
879- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L143-L145 '
> 863+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L143-L145 '
> 880864 < span > src/index.js</ span >
881865 </ a >
882866
@@ -886,9 +870,7 @@ <h3 class='left m0 panel-title' id='box'>
886870 < p > Helper method for creating a visual box (using boxen)</ p >
887871
888872
889-
890- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> box(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > , options: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object "> Object</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
891-
873+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> box(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > , options: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object "> Object</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
892874
893875
894876
@@ -963,7 +945,7 @@ <h3 class='left m0 panel-title' id='tosubscript'>
963945 </ h3 >
964946
965947
966- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L152-L154 '
> 948+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L152-L154 '
> 967949 < span > src/index.js</ span >
968950 </ a >
969951
@@ -973,9 +955,7 @@ <h3 class='left m0 panel-title' id='tosubscript'>
973955 < p > Helper method from creating a simple Unicode subscript representation.</ p >
974956
975957
976-
977- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> toSubscript(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
978-
958+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> toSubscript(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
979959
980960
981961
@@ -1041,7 +1021,7 @@ <h3 class='left m0 panel-title' id='tosuperscript'>
10411021 </ h3 >
10421022
10431023
1044- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L161-L163 '
> 1024+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L161-L163 '
> 10451025 < span > src/index.js</ span >
10461026 </ a >
10471027
@@ -1051,9 +1031,7 @@ <h3 class='left m0 panel-title' id='tosuperscript'>
10511031 < p > Helper method from creating a simple Unicode superscript representation.</ p >
10521032
10531033
1054-
1055- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> toSuperscript(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
1056-
1034+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> toSuperscript(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
10571035
10581036
10591037
@@ -1119,7 +1097,7 @@ <h3 class='left m0 panel-title' id='emoji'>
11191097 </ h3 >
11201098
11211099
1122- < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L170-L172 '
> 1100+ < a class ='
pl3 pr1 right rounded github '
href ='
https://[email protected] /MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L170-L172 '
> 11231101 < span > src/index.js</ span >
11241102 </ a >
11251103
@@ -1129,9 +1107,7 @@ <h3 class='left m0 panel-title' id='emoji'>
11291107 < p > Helper method from creating a wide Emoji character.</ p >
11301108
11311109
1132-
1133- < div class ='pre p1 bg-darken-1 mt0 rounded signature '> emoji(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
1134-
1110+ < div class ='pre p1 bg-darken-1 mt0 rounded signature '> emoji(str: < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > ) → < a href ="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String "> String</ a > </ div >
11351111
11361112
11371113
0 commit comments