2
2
< html >
3
3
< head >
4
4
< 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 '>
6
7
< meta name ="viewport " content ="width=device-width,initial-scale=1 ">
7
8
< link href ="assets/css/ace.min.css " rel ="stylesheet ">
8
9
< link href ="assets/fonts/TypoPRO-Hack/TypoPRO-Hack.css " type ="text/css " rel ="stylesheet " />
9
10
< link href ="assets/fonts/TypoPRO-FiraSans/TypoPRO-FiraSans.css " type ="text/css " rel ="stylesheet " />
10
11
< link href ="assets/css/style.css " type ="text/css " rel ="stylesheet " />
11
- < meta name ='description ' content ='Esoteric string formatting '>
12
12
</ head >
13
13
< body class ='documentation m0 '>
14
14
< div class ="flex ">
15
15
< div id ='split-left ' class ='overflow-auto fs0 height-viewport-100 sidebar '>
16
16
< div class ='py1 px2 '>
17
17
< 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 >
19
19
< input
20
20
placeholder ="Filter "
21
21
id ="filter-input "
@@ -271,7 +271,7 @@ <h3 class='left m0 panel-title' id='constructor'>
271
271
</ h3 >
272
272
273
273
274
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L13-L15 '>
274
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L13-L15 '>
275
275
< span > src/index.js</ span >
276
276
</ a >
277
277
@@ -281,9 +281,7 @@ <h3 class='left m0 panel-title' id='constructor'>
281
281
< p > Contruct a BespokeString instance.</ p >
282
282
283
283
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 >
287
285
288
286
289
287
@@ -341,7 +339,7 @@ <h3 class='left m0 panel-title' id='pad'>
341
339
</ h3 >
342
340
343
341
344
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L51-L55 '>
342
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L51-L55 '>
345
343
< span > src/index.js</ span >
346
344
</ a >
347
345
@@ -351,9 +349,7 @@ <h3 class='left m0 panel-title' id='pad'>
351
349
< p > Pad the contents.</ p >
352
350
353
351
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 >
357
353
358
354
359
355
@@ -430,7 +426,7 @@ <h3 class='left m0 panel-title' id='tosub'>
430
426
</ h3 >
431
427
432
428
433
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L61-L63 '>
429
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L61-L63 '>
434
430
< span > src/index.js</ span >
435
431
</ a >
436
432
@@ -440,9 +436,7 @@ <h3 class='left m0 panel-title' id='tosub'>
440
436
< p > Transform the contents to subscript characters.</ p >
441
437
442
438
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 >
446
440
447
441
448
442
@@ -494,7 +488,7 @@ <h3 class='left m0 panel-title' id='tosuper'>
494
488
</ h3 >
495
489
496
490
497
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L69-L71 '>
491
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L69-L71 '>
498
492
< span > src/index.js</ span >
499
493
</ a >
500
494
@@ -504,9 +498,7 @@ <h3 class='left m0 panel-title' id='tosuper'>
504
498
< p > Transform the contents to superscript characters.</ p >
505
499
506
500
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 >
510
502
511
503
512
504
@@ -558,7 +550,7 @@ <h3 class='left m0 panel-title' id='asemoji'>
558
550
</ h3 >
559
551
560
552
561
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L79-L82 '>
553
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L79-L82 '>
562
554
< span > src/index.js</ span >
563
555
</ a >
564
556
@@ -569,9 +561,7 @@ <h3 class='left m0 panel-title' id='asemoji'>
569
561
< p > Totally naïve implentation right now, just pad wide emoji chars with a space.</ p >
570
562
571
563
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 >
575
565
576
566
577
567
@@ -623,7 +613,7 @@ <h3 class='left m0 panel-title' id='inbox'>
623
613
</ h3 >
624
614
625
615
626
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L89-L106 '>
616
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L89-L106 '>
627
617
< span > src/index.js</ span >
628
618
</ a >
629
619
@@ -633,9 +623,7 @@ <h3 class='left m0 panel-title' id='inbox'>
633
623
< p > Print the content as a graphic box.</ p >
634
624
635
625
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 >
639
627
640
628
641
629
@@ -702,7 +690,7 @@ <h3 class='left m0 panel-title' id='bespokestring'>
702
690
</ h3 >
703
691
704
692
705
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L122-L124 '>
693
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L122-L124 '>
706
694
< span > src/index.js</ span >
707
695
</ a >
708
696
@@ -712,9 +700,7 @@ <h3 class='left m0 panel-title' id='bespokestring'>
712
700
< p > Helper method for creating a BespokeString instance</ p >
713
701
714
702
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 >
718
704
719
705
720
706
@@ -780,7 +766,7 @@ <h3 class='left m0 panel-title' id='pad'>
780
766
</ h3 >
781
767
782
768
783
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L133-L135 '>
769
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L133-L135 '>
784
770
< span > src/index.js</ span >
785
771
</ a >
786
772
@@ -790,9 +776,7 @@ <h3 class='left m0 panel-title' id='pad'>
790
776
< p > Helper method for padding a string.</ p >
791
777
792
778
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 >
796
780
797
781
798
782
@@ -876,7 +860,7 @@ <h3 class='left m0 panel-title' id='box'>
876
860
</ h3 >
877
861
878
862
879
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L143-L145 '>
863
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L143-L145 '>
880
864
< span > src/index.js</ span >
881
865
</ a >
882
866
@@ -886,9 +870,7 @@ <h3 class='left m0 panel-title' id='box'>
886
870
< p > Helper method for creating a visual box (using boxen)</ p >
887
871
888
872
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 >
892
874
893
875
894
876
@@ -963,7 +945,7 @@ <h3 class='left m0 panel-title' id='tosubscript'>
963
945
</ h3 >
964
946
965
947
966
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L152-L154 '>
948
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L152-L154 '>
967
949
< span > src/index.js</ span >
968
950
</ a >
969
951
@@ -973,9 +955,7 @@ <h3 class='left m0 panel-title' id='tosubscript'>
973
955
< p > Helper method from creating a simple Unicode subscript representation.</ p >
974
956
975
957
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 >
979
959
980
960
981
961
@@ -1041,7 +1021,7 @@ <h3 class='left m0 panel-title' id='tosuperscript'>
1041
1021
</ h3 >
1042
1022
1043
1023
1044
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L161-L163 '>
1024
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L161-L163 '>
1045
1025
< span > src/index.js</ span >
1046
1026
</ a >
1047
1027
@@ -1051,9 +1031,7 @@ <h3 class='left m0 panel-title' id='tosuperscript'>
1051
1031
< p > Helper method from creating a simple Unicode superscript representation.</ p >
1052
1032
1053
1033
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 >
1057
1035
1058
1036
1059
1037
@@ -1119,7 +1097,7 @@ <h3 class='left m0 panel-title' id='emoji'>
1119
1097
</ h3 >
1120
1098
1121
1099
1122
- < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1 /src/index.js#L170-L172 '>
1100
+ < a class ='pl3 pr1 right rounded github ' href ='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492 /src/index.js#L170-L172 '>
1123
1101
< span > src/index.js</ span >
1124
1102
</ a >
1125
1103
@@ -1129,9 +1107,7 @@ <h3 class='left m0 panel-title' id='emoji'>
1129
1107
< p > Helper method from creating a wide Emoji character.</ p >
1130
1108
1131
1109
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 >
1135
1111
1136
1112
1137
1113
0 commit comments