Skip to content

Commit

Permalink
Merge branch 'release/v0.5.6'
Browse files Browse the repository at this point in the history
  • Loading branch information
@MarkGriffiths
MarkGriffiths committed Feb 23, 2019
2 parents 62e28c9 + 2b9d5c9 commit 699a440
Show file tree
Hide file tree
Showing 3 changed files with 305 additions and 845 deletions.
78 changes: 27 additions & 51 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@
<html>
<head>
<meta charset="utf-8" />
<title>@thebespokepixel/string 0.5.5 | Documentation</title>
<title>@thebespokepixel/string 0.5.6 | Documentation</title>
<meta name='description' content='Esoteric string formatting'>
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="assets/css/ace.min.css" rel="stylesheet">
<link href="assets/fonts/TypoPRO-Hack/TypoPRO-Hack.css" type="text/css" rel="stylesheet" />
<link href="assets/fonts/TypoPRO-FiraSans/TypoPRO-FiraSans.css" type="text/css" rel="stylesheet" />
<link href="assets/css/style.css" type="text/css" rel="stylesheet" />
<meta name='description' content='Esoteric string formatting'>
</head>
<body class='documentation m0'>
<div class="flex">
<div id='split-left' class='overflow-auto fs0 height-viewport-100 sidebar'>
<div class='py1 px2'>
<h3 class="m0 no-anchor">@thebespokepixel/string</h3>
<div class="mb1"><code>0.5.5</code></div>
<div class="mb1"><code>0.5.6</code></div>
<input
placeholder="Filter"
id="filter-input"
Expand Down Expand Up @@ -271,7 +271,7 @@ <h3 class='left m0 panel-title' id='constructor'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L13-L15'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L13-L15'>
<span>src/index.js</span>
</a>

Expand All @@ -281,9 +281,7 @@ <h3 class='left m0 panel-title' id='constructor'>
<p>Contruct a BespokeString instance.</p>



<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>

<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>



Expand Down Expand Up @@ -341,7 +339,7 @@ <h3 class='left m0 panel-title' id='pad'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L51-L55'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L51-L55'>
<span>src/index.js</span>
</a>

Expand All @@ -351,9 +349,7 @@ <h3 class='left m0 panel-title' id='pad'>
<p>Pad the contents.</p>



<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>

<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>



Expand Down Expand Up @@ -430,7 +426,7 @@ <h3 class='left m0 panel-title' id='tosub'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L61-L63'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L61-L63'>
<span>src/index.js</span>
</a>

Expand All @@ -440,9 +436,7 @@ <h3 class='left m0 panel-title' id='tosub'>
<p>Transform the contents to subscript characters.</p>



<div class='pre p1 bg-darken-1 mt0 rounded signature'>toSub() → BespokeString</div>

<div class='pre p1 bg-darken-1 mt0 rounded signature'>toSub() → BespokeString</div>



Expand Down Expand Up @@ -494,7 +488,7 @@ <h3 class='left m0 panel-title' id='tosuper'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L69-L71'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L69-L71'>
<span>src/index.js</span>
</a>

Expand All @@ -504,9 +498,7 @@ <h3 class='left m0 panel-title' id='tosuper'>
<p>Transform the contents to superscript characters.</p>



<div class='pre p1 bg-darken-1 mt0 rounded signature'>toSuper() → BespokeString</div>

<div class='pre p1 bg-darken-1 mt0 rounded signature'>toSuper() → BespokeString</div>



Expand Down Expand Up @@ -558,7 +550,7 @@ <h3 class='left m0 panel-title' id='asemoji'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L79-L82'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L79-L82'>
<span>src/index.js</span>
</a>

Expand All @@ -569,9 +561,7 @@ <h3 class='left m0 panel-title' id='asemoji'>
<p>Totally naïve implentation right now, just pad wide emoji chars with a space.</p>



<div class='pre p1 bg-darken-1 mt0 rounded signature'>asEmoji() → BespokeString</div>

<div class='pre p1 bg-darken-1 mt0 rounded signature'>asEmoji() → BespokeString</div>



Expand Down Expand Up @@ -623,7 +613,7 @@ <h3 class='left m0 panel-title' id='inbox'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L89-L106'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L89-L106'>
<span>src/index.js</span>
</a>

Expand All @@ -633,9 +623,7 @@ <h3 class='left m0 panel-title' id='inbox'>
<p>Print the content as a graphic box.</p>



<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>

<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>



Expand Down Expand Up @@ -702,7 +690,7 @@ <h3 class='left m0 panel-title' id='bespokestring'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L122-L124'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L122-L124'>
<span>src/index.js</span>
</a>

Expand All @@ -712,9 +700,7 @@ <h3 class='left m0 panel-title' id='bespokestring'>
<p>Helper method for creating a BespokeString instance</p>



<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>

<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>



Expand Down Expand Up @@ -780,7 +766,7 @@ <h3 class='left m0 panel-title' id='pad'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L133-L135'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L133-L135'>
<span>src/index.js</span>
</a>

Expand All @@ -790,9 +776,7 @@ <h3 class='left m0 panel-title' id='pad'>
<p>Helper method for padding a string.</p>



<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>

<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>



Expand Down Expand Up @@ -876,7 +860,7 @@ <h3 class='left m0 panel-title' id='box'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L143-L145'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L143-L145'>
<span>src/index.js</span>
</a>

Expand All @@ -886,9 +870,7 @@ <h3 class='left m0 panel-title' id='box'>
<p>Helper method for creating a visual box (using boxen)</p>



<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>

<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>



Expand Down Expand Up @@ -963,7 +945,7 @@ <h3 class='left m0 panel-title' id='tosubscript'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L152-L154'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L152-L154'>
<span>src/index.js</span>
</a>

Expand All @@ -973,9 +955,7 @@ <h3 class='left m0 panel-title' id='tosubscript'>
<p>Helper method from creating a simple Unicode subscript representation.</p>



<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>

<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>



Expand Down Expand Up @@ -1041,7 +1021,7 @@ <h3 class='left m0 panel-title' id='tosuperscript'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L161-L163'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L161-L163'>
<span>src/index.js</span>
</a>

Expand All @@ -1051,9 +1031,7 @@ <h3 class='left m0 panel-title' id='tosuperscript'>
<p>Helper method from creating a simple Unicode superscript representation.</p>



<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>

<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>



Expand Down Expand Up @@ -1119,7 +1097,7 @@ <h3 class='left m0 panel-title' id='emoji'>
</h3>


<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/30dd3665f6981e1afa171acf56a3c548e5eb82e1/src/index.js#L170-L172'>
<a class='pl3 pr1 right rounded github' href='https://MarkGriffiths@github.com/MarkGriffiths/string/blob/243bb0cd402796c3967b4bb2c53f4d35a6397492/src/index.js#L170-L172'>
<span>src/index.js</span>
</a>

Expand All @@ -1129,9 +1107,7 @@ <h3 class='left m0 panel-title' id='emoji'>
<p>Helper method from creating a wide Emoji character.</p>



<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>

<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>



Expand Down
Loading

0 comments on commit 699a440

Please sign in to comment.