mirrors/CyberChef
1
0
Fork 0
mirror of https://github.com/gchq/CyberChef.git synced 2025-04-21 07:16:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
CyberChef/docs/StrUtils.html
n1474335 56dbb3fa40 Initial pages commit
2016-11-28 11:01:54 +00:00

3346 lines
No EOL
44 KiB
HTML
Executable file
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>CyberChef Namespace: StrUtils</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html"><img class="branding-logo" src="../build/prod/images/cyberchef-32x32.png"
alt="logo"/>CyberChef</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="FlowControl.html">FlowControl</a></li><li><a href="Utils.html">Utils</a></li><li><a href="Base.html">Base</a></li><li><a href="Base64.html">Base64</a></li><li><a href="BitwiseOp.html">BitwiseOp</a></li><li><a href="ByteRepr.html">ByteRepr</a></li><li><a href="CharEnc.html">CharEnc</a></li><li><a href="Checksum.html">Checksum</a></li><li><a href="Cipher.html">Cipher</a></li><li><a href="Code.html">Code</a></li><li><a href="Compress.html">Compress</a></li><li><a href="Convert.html">Convert</a></li><li><a href="DateTime.html">DateTime</a></li><li><a href="Endian.html">Endian</a></li><li><a href="Entropy.html">Entropy</a></li><li><a href="Extract.html">Extract</a></li><li><a href="FileType.html">FileType</a></li><li><a href="HTML.html">HTML</a></li><li><a href="HTTP.html">HTTP</a></li><li><a href="Hash.html">Hash</a></li><li><a href="Hexdump.html">Hexdump</a></li><li><a href="IP.html">IP</a></li><li><a href="JS.html">JS</a></li><li><a href="MAC.html">MAC</a></li><li><a href="Numberwang.html">Numberwang</a></li><li><a href="OS.html">OS</a></li><li><a href="PublicKey.html">PublicKey</a></li><li><a href="Punycode.html">Punycode</a></li><li><a href="QuotedPrintable.html">QuotedPrintable</a></li><li><a href="Rotate.html">Rotate</a></li><li><a href="SeqUtils.html">SeqUtils</a></li><li><a href="StrUtils.html">StrUtils</a></li><li><a href="Tidy.html">Tidy</a></li><li><a href="URL_.html">URL_</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Unicode.html">Unicode</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="Chef.html">Chef</a></li><li><a href="Dish.html">Dish</a></li><li><a href="Ingredient.html">Ingredient</a></li><li><a href="Operation.html">Operation</a></li><li><a href="Recipe.html">Recipe</a></li><li><a href="ControlsWaiter.html">ControlsWaiter</a></li><li><a href="HTMLApp.html">HTMLApp</a></li><li><a href="HTMLCategory.html">HTMLCategory</a></li><li><a href="HTMLIngredient.html">HTMLIngredient</a></li><li><a href="HTMLOperation.html">HTMLOperation</a></li><li><a href="HighlighterWaiter.html">HighlighterWaiter</a></li><li><a href="InputWaiter.html">InputWaiter</a></li><li><a href="Manager.html">Manager</a></li><li><a href="OperationsWaiter.html">OperationsWaiter</a></li><li><a href="OptionsWaiter.html">OptionsWaiter</a></li><li><a href="OutputWaiter.html">OutputWaiter</a></li><li><a href="RecipeWaiter.html">RecipeWaiter</a></li><li><a href="SeasonalWaiter.html">SeasonalWaiter</a></li><li><a href="WindowWaiter.html">WindowWaiter</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="Manager.html#event:appstart">Manager#event:appstart</a></li><li><a href="Manager.html#event:operationadd">Manager#event:operationadd</a></li><li><a href="Manager.html#event:operationremove">Manager#event:operationremove</a></li><li><a href="Manager.html#event:oplistcreate">Manager#event:oplistcreate</a></li><li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="global.html#Categories">Categories</a></li><li><a href="global.html#OperationConfig">OperationConfig</a></li><li><a href="global.html#main">main</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Namespace: StrUtils</h1>
<section>
<header>
<h2>
StrUtils
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>String utility operations.</p></div>
<dl class="details">
<dt class="tag-author method-doc-label method-doc-details-label">Author:</dt>
<dd class="tag-author">
<ul>
<li>&lt;p>n1474335 [n1474335@gmail.com]&lt;/p></li>
</ul>
</dd>
<dt class="tag-copyright method-doc-label method-doc-details-label">Copyright:</dt>
<dd class="tag-copyright">
<ul class="dummy">
<li>Crown Copyright 2016</li>
</ul>
</dd>
<dt class="tag-license method-doc-label method-doc-details-label">License:</dt>
<dd class="tag-license">
<ul class="dummy">
<li>Apache-2.0</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-12">line 12</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<hr>
<dt class="name" id=".REGEX_PRE_POPULATE">
<h4 id=".REGEX_PRE_POPULATE"><span class="type-signature">&lt;static, constant> </span>REGEX_PRE_POPULATE<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>["{\"name\":\"User defined\",\"value\":\"\"}","{\"name\":\"IPv4 address\",\"value\":\"(?:(?:\\\\d|[01]?\\\\d\\\\d|2[0-4]\\\\d|25[0-5])\\\\.){3}(?:25[0-5]|2[0-4]\\\\d|[01]?\\\\d\\\\d|\\\\d)(?:\\\\/\\\\d{1,2})?\"}","{\"name\":\"IPv6 address\",\"value\":\"((?=.*::)(?!.*::.+::)(::)?([\\\\dA-Fa-f]{1,4}:(:|\\\\b)|){5}|([\\\\dA-Fa-f]{1,4}:){6})((([\\\\dA-Fa-f]{1,4}((?!\\\\3)::|:\\\\b|(?![\\\\dA-Fa-f])))|(?!\\\\2\\\\3)){2}|(((2[0-4]|1\\\\d|[1-9])?\\\\d|25[0-5])\\\\.?\\\\b){4})\"}","{\"name\":\"Email address\",\"value\":\"(\\\\w[-.\\\\w]*)@([-\\\\w]+(?:\\\\.[-\\\\w]+)*)\\\\.([A-Za-z]{2,4})\"}","{\"name\":\"URL\",\"value\":\"([A-Za-z]+://)([-\\\\w]+(?:\\\\.\\\\w[-\\\\w]*)+)(:\\\\d+)?(/[^.!,?;\\\"\\\\x27<>()\\\\[\\\\]{}\\\\s\\\\x7F-\\\\xFF]*(?:[.!,?]+[^.!,?;\\\"\\\\x27<>()\\\\[\\\\]{}\\\\s\\\\x7F-\\\\xFF]+)*)?\"}","{\"name\":\"Domain\",\"value\":\"(?:(https?):\\\\/\\\\/)?([-\\\\w.]+)\\\\.(com|net|org|biz|info|co|uk|onion|int|mobi|name|edu|gov|mil|eu|ac|ae|af|de|ca|ch|cn|cy|es|gb|hk|il|in|io|tv|me|nl|no|nz|ro|ru|tr|us|az|ir|kz|uz|pk)+\"}","{\"name\":\"Windows file path\",\"value\":\"([A-Za-z]):\\\\\\\\((?:[A-Za-z\\\\d][A-Za-z\\\\d\\\\- \\\\x27_\\\\(\\\\)]{0,61}\\\\\\\\?)*[A-Za-z\\\\d][A-Za-z\\\\d\\\\- \\\\x27_\\\\(\\\\)]{0,61})(\\\\.[A-Za-z\\\\d]{1,6})?\"}","{\"name\":\"UNIX file path\",\"value\":\"(?:/[A-Za-z\\\\d.][A-Za-z\\\\d\\\\-.]{0,61})+\"}","{\"name\":\"MAC address\",\"value\":\"[A-Fa-f\\\\d]{2}(?:[:-][A-Fa-f\\\\d]{2}){5}\"}","{\"name\":\"Date (yyyy-mm-dd)\",\"value\":\"((?:19|20)\\\\d\\\\d)[- /.](0[1-9]|1[012])[- /.](0[1-9]|[12][0-9]|3[01])\"}","{\"name\":\"Date (dd/mm/yyyy)\",\"value\":\"(0[1-9]|[12][0-9]|3[01])[- /.](0[1-9]|1[012])[- /.]((?:19|20)\\\\d\\\\d)\"}","{\"name\":\"Date (mm/dd/yyyy)\",\"value\":\"(0[1-9]|1[012])[- /.](0[1-9]|[12][0-9]|3[01])[- /.]((?:19|20)\\\\d\\\\d)\"}","{\"name\":\"Strings\",\"value\":\"[A-Za-z\\\\d/\\\\-:.,_$%\\\\x27\\\"()<>= !\\\\[\\\\]{}@]{4,}\"}"]</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-18">line 18</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".REGEX_CASE_INSENSITIVE">
<h4 id=".REGEX_CASE_INSENSITIVE"><span class="type-signature">&lt;static, constant> </span>REGEX_CASE_INSENSITIVE<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-76">line 76</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".REGEX_MULTILINE_MATCHING">
<h4 id=".REGEX_MULTILINE_MATCHING"><span class="type-signature">&lt;static, constant> </span>REGEX_MULTILINE_MATCHING<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-81">line 81</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".OUTPUT_FORMAT">
<h4 id=".OUTPUT_FORMAT"><span class="type-signature">&lt;static, constant> </span>OUTPUT_FORMAT<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>["Highlight matches","List matches","List capture groups","List matches with capture groups"]</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-86">line 86</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".DISPLAY_TOTAL">
<h4 id=".DISPLAY_TOTAL"><span class="type-signature">&lt;static, constant> </span>DISPLAY_TOTAL<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-91">line 91</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".CASE_SCOPE">
<h4 id=".CASE_SCOPE"><span class="type-signature">&lt;static, constant> </span>CASE_SCOPE<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>["All","Word","Sentence","Paragraph"]</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-140">line 140</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".SEARCH_TYPE">
<h4 id=".SEARCH_TYPE"><span class="type-signature">&lt;static, constant> </span>SEARCH_TYPE<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>["Regex","Extended (\\n, \\t, \\x...)","Simple string"]</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-189">line 189</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".FIND_REPLACE_GLOBAL">
<h4 id=".FIND_REPLACE_GLOBAL"><span class="type-signature">&lt;static, constant> </span>FIND_REPLACE_GLOBAL<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-194">line 194</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".FIND_REPLACE_CASE">
<h4 id=".FIND_REPLACE_CASE"><span class="type-signature">&lt;static, constant> </span>FIND_REPLACE_CASE<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-199">line 199</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".FIND_REPLACE_MULTILINE">
<h4 id=".FIND_REPLACE_MULTILINE"><span class="type-signature">&lt;static, constant> </span>FIND_REPLACE_MULTILINE<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-204">line 204</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".SPLIT_DELIM">
<h4 id=".SPLIT_DELIM"><span class="type-signature">&lt;static, constant> </span>SPLIT_DELIM<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>,</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-243">line 243</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".DELIMITER_OPTIONS">
<h4 id=".DELIMITER_OPTIONS"><span class="type-signature">&lt;static, constant> </span>DELIMITER_OPTIONS<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>["Line feed","CRLF","Space","Comma","Semi-colon","Colon","Nothing (separate chars)"]</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-248">line 248</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".DIFF_SAMPLE_DELIMITER">
<h4 id=".DIFF_SAMPLE_DELIMITER"><span class="type-signature">&lt;static, constant> </span>DIFF_SAMPLE_DELIMITER<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>\n\n</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-270">line 270</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".DIFF_BY">
<h4 id=".DIFF_BY"><span class="type-signature">&lt;static, constant> </span>DIFF_BY<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>["Character","Word","Line","Sentence","CSS","JSON"]</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-275">line 275</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".OFF_CHK_SAMPLE_DELIMITER">
<h4 id=".OFF_CHK_SAMPLE_DELIMITER"><span class="type-signature">&lt;static, constant> </span>OFF_CHK_SAMPLE_DELIMITER<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>\n\n</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-347">line 347</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id=".run_regex"><span class="type-signature">&lt;static> </span>run_regex(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>Regular expression operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-100">line 100</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">html</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_upper"><span class="type-signature">&lt;static> </span>run_upper(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>To Upper case operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-149">line 149</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_lower"><span class="type-signature">&lt;static> </span>run_lower(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>To Upper case operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-180">line 180</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_find_replace"><span class="type-signature">&lt;static> </span>run_find_replace(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>Find / Replace operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-213">line 213</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_split"><span class="type-signature">&lt;static> </span>run_split(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>Split operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-257">line 257</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_diff"><span class="type-signature">&lt;static> </span>run_diff(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>Diff operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-284">line 284</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">html</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_offset_checker"><span class="type-signature">&lt;static> </span>run_offset_checker(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>Offset checker operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-356">line 356</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">html</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_parse_escaped_string"><span class="type-signature">&lt;static> </span>run_parse_escaped_string(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>Parse escaped string operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-430">line 430</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="._regex_highlight"><span class="type-signature">&lt;private, static> </span>_regex_highlight(input, regex, display_total)</h4>
</dt>
<dd>
<div class="description">
<p>Adds HTML highlights to matches within a string.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>regex</code></td>
<td class="type">
<span class="param-type">RegExp</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>display_total</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-444">line 444</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="._regex_list"><span class="type-signature">&lt;private, static> </span>_regex_list(input, regex, display_total, matches, capture_groups)</h4>
</dt>
<dd>
<div class="description">
<p>Creates a string listing the matches within a string.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>regex</code></td>
<td class="type">
<span class="param-type">RegExp</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>display_total</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>matches</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Display full match</p></td>
</tr>
<tr>
<td class="name"><code>capture_groups</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Display each of the capture groups separately</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_StrUtils.js.html">operations/StrUtils.js</a>,
<a href="operations_StrUtils.js.html#sunlight-1-line-486">line 486</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="copyright">
&copy; Crown Copyright 2016
</span>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
on Mon Nov 28th 2016
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink