[READ-ONLY] Mirror of https://github.com/FoxxMD/redact-string. Redact part or all of a string
foxxmd.github.io/redact-string
javascript
redact
redaction
replace-text
string
string-manipulation
typescript
Deploying to gh-pages from @ FoxxMD/redact-string@05f06549a3d5516b71a523e394077318dc409895 🚀
+25
-11
+12
-4
functions/redactString.html
+12
-4
functions/redactString.html
···
19
19
<ul class="tsd-signatures tsd-kind-function">
20
20
<li class="tsd-signature tsd-anchor-link" id="redactString">redact<wbr/>String<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, visibleCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RedactOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedactOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#redactString" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></li>
21
21
<li class="tsd-description">
22
+
<div class="tsd-comment tsd-typography"><p>Redact part or all of a string</p>
23
+
</div>
22
24
<div class="tsd-parameters">
23
25
<h4 class="tsd-parameters-title">Parameters</h4>
24
26
<ul class="tsd-parameter-list">
25
27
<li>
26
-
<h5>str: <span class="tsd-signature-type">string</span></h5></li>
28
+
<h5>str: <span class="tsd-signature-type">string</span></h5>
29
+
<div class="tsd-comment tsd-typography"><p>The string to redact</p>
30
+
</div></li>
27
31
<li>
28
-
<h5>visibleCount: <span class="tsd-signature-type">number</span></h5></li>
32
+
<h5>visibleCount: <span class="tsd-signature-type">number</span></h5>
33
+
<div class="tsd-comment tsd-typography"><p>The number of characters to leave visible</p>
34
+
</div></li>
29
35
<li>
30
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/RedactOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedactOptions</a></h5></li></ul></div>
36
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/RedactOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedactOptions</a></h5>
37
+
<div class="tsd-comment tsd-typography"><p>Define how redaction behavior occurs</p>
38
+
</div></li></ul></div>
31
39
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
32
40
<ul>
33
-
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/1407700/src/index.ts#L7">index.ts:7</a></li></ul></aside></li></ul></section></div>
41
+
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/05f0654/src/index.ts#L23">index.ts:23</a></li></ul></aside></li></ul></section></div>
34
42
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
35
43
<div class="tsd-navigation settings">
36
44
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
+13
-7
interfaces/RedactOptions.html
+13
-7
interfaces/RedactOptions.html
···
20
20
<ul class="tsd-hierarchy">
21
21
<li><span class="target">RedactOptions</span></li></ul></section><aside class="tsd-sources">
22
22
<ul>
23
-
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/1407700/src/index.ts#L1">index.ts:1</a></li></ul></aside>
23
+
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/05f0654/src/index.ts#L1">index.ts:1</a></li></ul></aside>
24
24
<section class="tsd-panel-group tsd-index-group">
25
25
<section class="tsd-panel tsd-index-panel">
26
26
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
···
36
36
<h2>Properties</h2>
37
37
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="replaceFrom" class="tsd-anchor"></a>
38
38
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>replace<wbr/>From</span><a href="#replaceFrom" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
39
-
<div class="tsd-signature">replace<wbr/>From<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"start"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"end"</span></div><aside class="tsd-sources">
39
+
<div class="tsd-signature">replace<wbr/>From<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"start"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"end"</span></div>
40
+
<div class="tsd-comment tsd-typography"><p>Replace characters starting at the start or end of string (default start)</p>
41
+
</div><aside class="tsd-sources">
40
42
<ul>
41
-
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/1407700/src/index.ts#L2">index.ts:2</a></li></ul></aside></section>
43
+
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/05f0654/src/index.ts#L5">index.ts:5</a></li></ul></aside></section>
42
44
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="replaceWith" class="tsd-anchor"></a>
43
45
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>replace<wbr/>With</span><a href="#replaceWith" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
44
-
<div class="tsd-signature">replace<wbr/>With<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
46
+
<div class="tsd-signature">replace<wbr/>With<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
47
+
<div class="tsd-comment tsd-typography"><p>The character/string that characters are replaced with (default '*')</p>
48
+
</div><aside class="tsd-sources">
45
49
<ul>
46
-
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/1407700/src/index.ts#L3">index.ts:3</a></li></ul></aside></section>
50
+
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/05f0654/src/index.ts#L9">index.ts:9</a></li></ul></aside></section>
47
51
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="replace" class="tsd-anchor"></a>
48
52
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>replace</span><a href="#replace" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
49
-
<div class="tsd-signature">replace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"any"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"alphanumeric"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"alpha"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"numeric"</span></div><aside class="tsd-sources">
53
+
<div class="tsd-signature">replace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"any"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"alphanumeric"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"alpha"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"numeric"</span></div>
54
+
<div class="tsd-comment tsd-typography"><p>Which type of characters to replace in the string (default any)</p>
55
+
</div><aside class="tsd-sources">
50
56
<ul>
51
-
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/1407700/src/index.ts#L4">index.ts:4</a></li></ul></aside></section></section></div>
57
+
<li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/05f0654/src/index.ts#L13">index.ts:13</a></li></ul></aside></section></section></div>
52
58
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
53
59
<div class="tsd-navigation settings">
54
60
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">