| 1 |
<!doctype html> |
| 2 |
<html class="default no-js"> |
| 3 |
<head> |
| 4 |
<meta charset="utf-8"> |
| 5 |
<meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| 6 |
<title>optional-require</title> |
| 7 |
<meta name="description" content="Documentation for optional-require"> |
| 8 |
<meta name="viewport" content="width=device-width, initial-scale=1"> |
| 9 |
<link rel="stylesheet" href="assets/css/main.css"> |
| 10 |
<script async src="assets/js/search.js" id="search-script"></script> |
| 11 |
</head> |
| 12 |
<body> |
| 13 |
<header> |
| 14 |
<div class="tsd-page-toolbar"> |
| 15 |
<div class="container"> |
| 16 |
<div class="table-wrap"> |
| 17 |
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> |
| 18 |
<div class="field"> |
| 19 |
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> |
| 20 |
<input id="tsd-search-field" type="text" /> |
| 21 |
</div> |
| 22 |
<ul class="results"> |
| 23 |
<li class="state loading">Preparing search index...</li> |
| 24 |
<li class="state failure">The search index is not available</li> |
| 25 |
</ul> |
| 26 |
<a href="index.html" class="title">optional-require</a> |
| 27 |
</div> |
| 28 |
<div class="table-cell" id="tsd-widgets"> |
| 29 |
<div id="tsd-filter"> |
| 30 |
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> |
| 31 |
<div class="tsd-filter-group"> |
| 32 |
<div class="tsd-select" id="tsd-filter-visibility"> |
| 33 |
<span class="tsd-select-label">All</span> |
| 34 |
<ul class="tsd-select-list"> |
| 35 |
<li data-value="public">Public</li> |
| 36 |
<li data-value="protected">Public/Protected</li> |
| 37 |
<li data-value="private" class="selected">All</li> |
| 38 |
</ul> |
| 39 |
</div> |
| 40 |
<input type="checkbox" id="tsd-filter-inherited" checked /> |
| 41 |
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> |
| 42 |
<input type="checkbox" id="tsd-filter-externals" checked /> |
| 43 |
<label class="tsd-widget" for="tsd-filter-externals">Externals</label> |
| 44 |
</div> |
| 45 |
</div> |
| 46 |
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> |
| 47 |
</div> |
| 48 |
</div> |
| 49 |
</div> |
| 50 |
</div> |
| 51 |
<div class="tsd-page-title"> |
| 52 |
<div class="container"> |
| 53 |
<h1>optional-require</h1> |
| 54 |
</div> |
| 55 |
</div> |
| 56 |
</header> |
| 57 |
<div class="container container-main"> |
| 58 |
<div class="row"> |
| 59 |
<div class="col-8 col-content"> |
| 60 |
<section class="tsd-panel-group tsd-index-group"> |
| 61 |
<h2>Index</h2> |
| 62 |
<section class="tsd-panel tsd-index-panel"> |
| 63 |
<div class="tsd-index-content"> |
| 64 |
<section class="tsd-index-section "> |
| 65 |
<h3>Type aliases</h3> |
| 66 |
<ul class="tsd-index-list"> |
| 67 |
<li class="tsd-kind-type-alias"><a href="modules.html#logfunction" class="tsd-kind-icon">Log<wbr>Function</a></li> |
| 68 |
<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#optionalrequirefunction" class="tsd-kind-icon">Optional<wbr>Require<wbr>Function</a></li> |
| 69 |
<li class="tsd-kind-type-alias"><a href="modules.html#optionalrequireopts" class="tsd-kind-icon">Optional<wbr>Require<wbr>Opts</a></li> |
| 70 |
</ul> |
| 71 |
</section> |
| 72 |
<section class="tsd-index-section "> |
| 73 |
<h3>Variables</h3> |
| 74 |
<ul class="tsd-index-list"> |
| 75 |
<li class="tsd-kind-variable"><a href="modules.html#optionalrequire" class="tsd-kind-icon">optional<wbr>Require</a></li> |
| 76 |
<li class="tsd-kind-variable"><a href="modules.html#optionalrequirecwd" class="tsd-kind-icon">optional<wbr>Require<wbr>Cwd</a></li> |
| 77 |
</ul> |
| 78 |
</section> |
| 79 |
<section class="tsd-index-section "> |
| 80 |
<h3>Functions</h3> |
| 81 |
<ul class="tsd-index-list"> |
| 82 |
<li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#makeoptionalrequire" class="tsd-kind-icon">make<wbr>Optional<wbr>Require</a></li> |
| 83 |
<li class="tsd-kind-function"><a href="modules.html#setdefaultlog" class="tsd-kind-icon">set<wbr>Default<wbr>Log</a></li> |
| 84 |
<li class="tsd-kind-function"><a href="modules.html#tryrequire" class="tsd-kind-icon">try<wbr>Require</a></li> |
| 85 |
<li class="tsd-kind-function"><a href="modules.html#tryresolve" class="tsd-kind-icon">try<wbr>Resolve</a></li> |
| 86 |
</ul> |
| 87 |
</section> |
| 88 |
</div> |
| 89 |
</section> |
| 90 |
</section> |
| 91 |
<section class="tsd-panel-group tsd-member-group "> |
| 92 |
<h2>Type aliases</h2> |
| 93 |
<section class="tsd-panel tsd-member tsd-kind-type-alias"> |
| 94 |
<a name="logfunction" class="tsd-anchor"></a> |
| 95 |
<h3>Log<wbr>Function</h3> |
| 96 |
<div class="tsd-signature tsd-kind-icon">Log<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div> |
| 97 |
<aside class="tsd-sources"> |
| 98 |
<ul> |
| 99 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L44">index.ts:44</a></li> |
| 100 |
</ul> |
| 101 |
</aside> |
| 102 |
<div class="tsd-comment tsd-typography"> |
| 103 |
<div class="lead"> |
| 104 |
<p>function to log in case require module was not found</p> |
| 105 |
</div> |
| 106 |
<dl class="tsd-comment-tags"> |
| 107 |
<dt>params</dt> |
| 108 |
<dd><p>message - message to log</p> |
| 109 |
</dd> |
| 110 |
<dt>params</dt> |
| 111 |
<dd><p>path - path of the module that user tried to require</p> |
| 112 |
</dd> |
| 113 |
</dl> |
| 114 |
</div> |
| 115 |
<div class="tsd-type-declaration"> |
| 116 |
<h4>Type declaration</h4> |
| 117 |
<ul class="tsd-parameters"> |
| 118 |
<li class="tsd-parameter-signature"> |
| 119 |
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> |
| 120 |
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| 121 |
</ul> |
| 122 |
<ul class="tsd-descriptions"> |
| 123 |
<li class="tsd-description"> |
| 124 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 125 |
<ul class="tsd-parameters"> |
| 126 |
<li> |
| 127 |
<h5>message: <span class="tsd-signature-type">string</span></h5> |
| 128 |
</li> |
| 129 |
<li> |
| 130 |
<h5>path: <span class="tsd-signature-type">string</span></h5> |
| 131 |
</li> |
| 132 |
</ul> |
| 133 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 134 |
</li> |
| 135 |
</ul> |
| 136 |
</li> |
| 137 |
</ul> |
| 138 |
</div> |
| 139 |
</section> |
| 140 |
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"> |
| 141 |
<a name="optionalrequirefunction" class="tsd-anchor"></a> |
| 142 |
<h3>Optional<wbr>Require<wbr>Function</h3> |
| 143 |
<div class="tsd-signature tsd-kind-icon">Optional<wbr>Require<wbr>Function<T><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>log<span class="tsd-signature-symbol">: </span><a href="modules.html#logfunction" class="tsd-signature-type" data-tsd-kind="Type alias">LogFunction</a><span class="tsd-signature-symbol">; </span>resolve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opsOrMsg<span class="tsd-signature-symbol">?: </span><a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div> |
| 144 |
<aside class="tsd-sources"> |
| 145 |
<ul> |
| 146 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L218">index.ts:218</a></li> |
| 147 |
</ul> |
| 148 |
</aside> |
| 149 |
<div class="tsd-comment tsd-typography"> |
| 150 |
<div class="lead"> |
| 151 |
<p>function to require a module with optional handling in case it's not found or fail to require</p> |
| 152 |
</div> |
| 153 |
</div> |
| 154 |
<h4 class="tsd-type-parameters-title">Type parameters</h4> |
| 155 |
<ul class="tsd-type-parameters"> |
| 156 |
<li> |
| 157 |
<h4>T = <span class="tsd-signature-type">any</span></h4> |
| 158 |
</li> |
| 159 |
</ul> |
| 160 |
<div class="tsd-type-declaration"> |
| 161 |
<h4>Type declaration</h4> |
| 162 |
<ul class="tsd-parameters"> |
| 163 |
<li class="tsd-parameter-signature"> |
| 164 |
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> |
| 165 |
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, optsOrMsg<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> |
| 166 |
</ul> |
| 167 |
<ul class="tsd-descriptions"> |
| 168 |
<li class="tsd-description"> |
| 169 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 170 |
<ul class="tsd-parameters"> |
| 171 |
<li> |
| 172 |
<h5>path: <span class="tsd-signature-type">string</span></h5> |
| 173 |
<div class="tsd-comment tsd-typography"> |
| 174 |
<p>path to module to require</p> |
| 175 |
</div> |
| 176 |
</li> |
| 177 |
<li> |
| 178 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> optsOrMsg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a></h5> |
| 179 |
<div class="tsd-comment tsd-typography"> |
| 180 |
<p>options or message to log when module not found</p> |
| 181 |
</div> |
| 182 |
</li> |
| 183 |
</ul> |
| 184 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> |
| 185 |
</li> |
| 186 |
</ul> |
| 187 |
</li> |
| 188 |
<li class="tsd-parameter"> |
| 189 |
<h5>log<span class="tsd-signature-symbol">: </span><a href="modules.html#logfunction" class="tsd-signature-type" data-tsd-kind="Type alias">LogFunction</a></h5> |
| 190 |
<div class="tsd-comment tsd-typography"> |
| 191 |
<div class="lead"> |
| 192 |
<p>function to log message, default to use <code>console.log</code>, you can replace this with |
| 193 |
another function.</p> |
| 194 |
</div> |
| 195 |
</div> |
| 196 |
</li> |
| 197 |
<li class="tsd-parameter"> |
| 198 |
<h5>resolve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opsOrMsg<span class="tsd-signature-symbol">?: </span><a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span></h5> |
| 199 |
<div class="tsd-comment tsd-typography"> |
| 200 |
<div class="lead"> |
| 201 |
<p>resolve the module's full path</p> |
| 202 |
</div> |
| 203 |
<dl class="tsd-comment-tags"> |
| 204 |
<dt>param</dt> |
| 205 |
<dd><p>path to module to resolve</p> |
| 206 |
</dd> |
| 207 |
<dt>param</dt> |
| 208 |
<dd><p>options or message to log when module not found</p> |
| 209 |
</dd> |
| 210 |
<dt>returns</dt> |
| 211 |
<dd><p>resolve result</p> |
| 212 |
</dd> |
| 213 |
</dl> |
| 214 |
</div> |
| 215 |
<ul class="tsd-parameters"> |
| 216 |
<li class="tsd-parameter-signature"> |
| 217 |
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> |
| 218 |
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opsOrMsg<span class="tsd-signature-symbol">?: </span><a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> |
| 219 |
</ul> |
| 220 |
<ul class="tsd-descriptions"> |
| 221 |
<li class="tsd-description"> |
| 222 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 223 |
<ul class="tsd-parameters"> |
| 224 |
<li> |
| 225 |
<h5>path: <span class="tsd-signature-type">string</span></h5> |
| 226 |
</li> |
| 227 |
<li> |
| 228 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> opsOrMsg: <a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5> |
| 229 |
</li> |
| 230 |
</ul> |
| 231 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> |
| 232 |
</li> |
| 233 |
</ul> |
| 234 |
</li> |
| 235 |
</ul> |
| 236 |
</li> |
| 237 |
</ul> |
| 238 |
</div> |
| 239 |
</section> |
| 240 |
<section class="tsd-panel tsd-member tsd-kind-type-alias"> |
| 241 |
<a name="optionalrequireopts" class="tsd-anchor"></a> |
| 242 |
<h3>Optional<wbr>Require<wbr>Opts</h3> |
| 243 |
<div class="tsd-signature tsd-kind-icon">Optional<wbr>Require<wbr>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>default<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>fail<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>log<span class="tsd-signature-symbol">?: </span><a href="modules.html#logfunction" class="tsd-signature-type" data-tsd-kind="Type alias">LogFunction</a><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>notFound<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>require<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">NodeRequire</span><span class="tsd-signature-symbol">; </span>resolve<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div> |
| 244 |
<aside class="tsd-sources"> |
| 245 |
<ul> |
| 246 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L49">index.ts:49</a></li> |
| 247 |
</ul> |
| 248 |
</aside> |
| 249 |
<div class="tsd-comment tsd-typography"> |
| 250 |
<div class="lead"> |
| 251 |
<p>Options for calling optionalRequire</p> |
| 252 |
</div> |
| 253 |
</div> |
| 254 |
<div class="tsd-type-declaration"> |
| 255 |
<h4>Type declaration</h4> |
| 256 |
<ul class="tsd-parameters"> |
| 257 |
<li class="tsd-parameter"> |
| 258 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> default<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5> |
| 259 |
<div class="tsd-comment tsd-typography"> |
| 260 |
<div class="lead"> |
| 261 |
<p>The value to return if error was <code>MODULE_NOT_FOUND</code> but <code>notFound</code> is not provided.</p> |
| 262 |
</div> |
| 263 |
</div> |
| 264 |
</li> |
| 265 |
<li class="tsd-parameter"> |
| 266 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fail<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">unknown</span></h5> |
| 267 |
<div class="tsd-comment tsd-typography"> |
| 268 |
<div class="lead"> |
| 269 |
<p><code>fail</code> is a function. If error from require was something other than <code>MODULE_NOT_FOUND</code>, |
| 270 |
for example, the module contains syntax error, then:</p> |
| 271 |
</div> |
| 272 |
<ul> |
| 273 |
<li>call <code>fail</code> if it's provided</li> |
| 274 |
<li>else rethrow the error</li> |
| 275 |
</ul> |
| 276 |
<dl class="tsd-comment-tags"> |
| 277 |
<dt>remark</dt> |
| 278 |
<dd><p>This is a separate callback from <code>notFound</code> so user can handle |
| 279 |
real <code>MODULE_NOT_FOUND</code> exception separately, or let the <code>default</code> be returned.</p> |
| 280 |
</dd> |
| 281 |
<dt>param</dt> |
| 282 |
<dd><p>the error from require</p> |
| 283 |
</dd> |
| 284 |
</dl> |
| 285 |
</div> |
| 286 |
<ul class="tsd-parameters"> |
| 287 |
<li class="tsd-parameter-signature"> |
| 288 |
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> |
| 289 |
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li> |
| 290 |
</ul> |
| 291 |
<ul class="tsd-descriptions"> |
| 292 |
<li class="tsd-description"> |
| 293 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 294 |
<ul class="tsd-parameters"> |
| 295 |
<li> |
| 296 |
<h5>err: <span class="tsd-signature-type">Error</span></h5> |
| 297 |
</li> |
| 298 |
</ul> |
| 299 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4> |
| 300 |
</li> |
| 301 |
</ul> |
| 302 |
</li> |
| 303 |
</ul> |
| 304 |
</li> |
| 305 |
<li class="tsd-parameter"> |
| 306 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> log<span class="tsd-signature-symbol">?: </span><a href="modules.html#logfunction" class="tsd-signature-type" data-tsd-kind="Type alias">LogFunction</a></h5> |
| 307 |
<div class="tsd-comment tsd-typography"> |
| 308 |
<div class="lead"> |
| 309 |
<p>function to log the module not found message, default log function uses <code>console.log</code></p> |
| 310 |
</div> |
| 311 |
</div> |
| 312 |
</li> |
| 313 |
<li class="tsd-parameter"> |
| 314 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> |
| 315 |
<div class="tsd-comment tsd-typography"> |
| 316 |
<div class="lead"> |
| 317 |
<p>Tell optional require to log a message if the module is not found.</p> |
| 318 |
<ul> |
| 319 |
<li>note: it doesn't log if the error is not due to the module not found</li> |
| 320 |
</ul> |
| 321 |
</div> |
| 322 |
<p>This field can have these values:</p> |
| 323 |
<ol> |
| 324 |
<li><code>true</code> - log with default message</li> |
| 325 |
<li>string - a string to prepend to the message being logged</li> |
| 326 |
</ol> |
| 327 |
<dl class="tsd-comment-tags"> |
| 328 |
<dt>remarks</dt> |
| 329 |
<dd><p>to further customize logging, set the <code>log</code> function.</p> |
| 330 |
</dd> |
| 331 |
</dl> |
| 332 |
</div> |
| 333 |
</li> |
| 334 |
<li class="tsd-parameter"> |
| 335 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> not<wbr>Found<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">unknown</span></h5> |
| 336 |
<div class="tsd-comment tsd-typography"> |
| 337 |
<div class="lead"> |
| 338 |
<p><code>notFound</code> is a function. If error from require was <code>MODULE_NOT_FOUND</code>, then:</p> |
| 339 |
</div> |
| 340 |
<ul> |
| 341 |
<li>call <code>notFound</code> if it's provided</li> |
| 342 |
<li>else return the <code>default</code> value.</li> |
| 343 |
</ul> |
| 344 |
<dl class="tsd-comment-tags"> |
| 345 |
<dt>remark</dt> |
| 346 |
<dd><p>in case the error was not <code>MODULE_NOT_FOUND</code>, will instead call the <code>fail</code> function |
| 347 |
if it's provided.</p> |
| 348 |
</dd> |
| 349 |
<dt>param</dt> |
| 350 |
<dd><p>the error from require</p> |
| 351 |
</dd> |
| 352 |
</dl> |
| 353 |
</div> |
| 354 |
<ul class="tsd-parameters"> |
| 355 |
<li class="tsd-parameter-signature"> |
| 356 |
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-literal"> |
| 357 |
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li> |
| 358 |
</ul> |
| 359 |
<ul class="tsd-descriptions"> |
| 360 |
<li class="tsd-description"> |
| 361 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 362 |
<ul class="tsd-parameters"> |
| 363 |
<li> |
| 364 |
<h5>err: <span class="tsd-signature-type">Error</span></h5> |
| 365 |
</li> |
| 366 |
</ul> |
| 367 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4> |
| 368 |
</li> |
| 369 |
</ul> |
| 370 |
</li> |
| 371 |
</ul> |
| 372 |
</li> |
| 373 |
<li class="tsd-parameter"> |
| 374 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> require<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">NodeRequire</span></h5> |
| 375 |
<div class="tsd-comment tsd-typography"> |
| 376 |
<div class="lead"> |
| 377 |
<p><code>require</code> is the node.js require function from caller's context.</p> |
| 378 |
</div> |
| 379 |
<p>If not provided, then use the one received when creating the optional require function</p> |
| 380 |
</div> |
| 381 |
</li> |
| 382 |
<li class="tsd-parameter"> |
| 383 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> resolve<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> |
| 384 |
<div class="tsd-comment tsd-typography"> |
| 385 |
<div class="lead"> |
| 386 |
<p>If <code>true</code>, then do an optional <code>require.resolve</code> and return the full path</p> |
| 387 |
</div> |
| 388 |
</div> |
| 389 |
</li> |
| 390 |
</ul> |
| 391 |
</div> |
| 392 |
</section> |
| 393 |
</section> |
| 394 |
<section class="tsd-panel-group tsd-member-group "> |
| 395 |
<h2>Variables</h2> |
| 396 |
<section class="tsd-panel tsd-member tsd-kind-variable"> |
| 397 |
<a name="optionalrequire" class="tsd-anchor"></a> |
| 398 |
<h3><span class="tsd-flag ts-flagConst">Const</span> optional<wbr>Require</h3> |
| 399 |
<div class="tsd-signature tsd-kind-icon">optional<wbr>Require<span class="tsd-signature-symbol">:</span> <a href="modules.html#optionalrequirefunction" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div> |
| 400 |
<aside class="tsd-sources"> |
| 401 |
<ul> |
| 402 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L276">index.ts:276</a></li> |
| 403 |
</ul> |
| 404 |
</aside> |
| 405 |
<div class="tsd-comment tsd-typography"> |
| 406 |
<div class="lead"> |
| 407 |
<p>A default optionalRequire function using <code>require</code> from optional-require's context.</p> |
| 408 |
</div> |
| 409 |
<dl class="tsd-comment-tags"> |
| 410 |
<dt>remarks</dt> |
| 411 |
<dd><p>because <code>require</code> is from optional-require's context, you won't be able to |
| 412 |
do <code>optionalRequire("./my-module")</code>.</p> |
| 413 |
<p>You can still override the <code>require</code> using <code>options.require</code> with the one from your |
| 414 |
calling context.</p> |
| 415 |
</dd> |
| 416 |
</dl> |
| 417 |
</div> |
| 418 |
</section> |
| 419 |
<section class="tsd-panel tsd-member tsd-kind-variable"> |
| 420 |
<a name="optionalrequirecwd" class="tsd-anchor"></a> |
| 421 |
<h3><span class="tsd-flag ts-flagConst">Const</span> optional<wbr>Require<wbr>Cwd</h3> |
| 422 |
<div class="tsd-signature tsd-kind-icon">optional<wbr>Require<wbr>Cwd<span class="tsd-signature-symbol">:</span> <a href="modules.html#optionalrequirefunction" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div> |
| 423 |
<aside class="tsd-sources"> |
| 424 |
<ul> |
| 425 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L287">index.ts:287</a></li> |
| 426 |
</ul> |
| 427 |
</aside> |
| 428 |
<div class="tsd-comment tsd-typography"> |
| 429 |
<div class="lead"> |
| 430 |
<p>An optionalRequire function using <code>require</code> from CWD context</p> |
| 431 |
</div> |
| 432 |
<dl class="tsd-comment-tags"> |
| 433 |
<dt>remarks</dt> |
| 434 |
<dd><p>because <code>require</code> is from CWD context, if you do <code>optionalRequireCwd("./my-module")</code> |
| 435 |
then it will look for <code>my-module</code> in CWD.</p> |
| 436 |
</dd> |
| 437 |
<dt>remarks</dt> |
| 438 |
<dd><p>You can still override the <code>require</code> using <code>options.require</code> with the one from your |
| 439 |
calling context.</p> |
| 440 |
</dd> |
| 441 |
</dl> |
| 442 |
</div> |
| 443 |
</section> |
| 444 |
</section> |
| 445 |
<section class="tsd-panel-group tsd-member-group "> |
| 446 |
<h2>Functions</h2> |
| 447 |
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"> |
| 448 |
<a name="makeoptionalrequire" class="tsd-anchor"></a> |
| 449 |
<h3>make<wbr>Optional<wbr>Require</h3> |
| 450 |
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"> |
| 451 |
<li class="tsd-signature tsd-kind-icon">make<wbr>Optional<wbr>Require<T><span class="tsd-signature-symbol">(</span>callerRequire<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeRequire</span>, log<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#optionalrequirefunction" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li> |
| 452 |
</ul> |
| 453 |
<ul class="tsd-descriptions"> |
| 454 |
<li class="tsd-description"> |
| 455 |
<aside class="tsd-sources"> |
| 456 |
<ul> |
| 457 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L246">index.ts:246</a></li> |
| 458 |
</ul> |
| 459 |
</aside> |
| 460 |
<div class="tsd-comment tsd-typography"> |
| 461 |
<div class="lead"> |
| 462 |
<p>Make an optional require function, using the <code>require</code> from caller's context.</p> |
| 463 |
</div> |
| 464 |
</div> |
| 465 |
<h4 class="tsd-type-parameters-title">Type parameters</h4> |
| 466 |
<ul class="tsd-type-parameters"> |
| 467 |
<li> |
| 468 |
<h4>T = <span class="tsd-signature-type">any</span></h4> |
| 469 |
</li> |
| 470 |
</ul> |
| 471 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 472 |
<ul class="tsd-parameters"> |
| 473 |
<li> |
| 474 |
<h5>callerRequire: <span class="tsd-signature-type">NodeRequire</span></h5> |
| 475 |
<div class="tsd-comment tsd-typography"> |
| 476 |
<p><code>require</code> from caller's context</p> |
| 477 |
</div> |
| 478 |
</li> |
| 479 |
<li> |
| 480 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> log: <span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5> |
| 481 |
<div class="tsd-comment tsd-typography"> |
| 482 |
<p>function to log if module is not found</p> |
| 483 |
</div> |
| 484 |
<ul class="tsd-parameters"> |
| 485 |
<li class="tsd-parameter-signature"> |
| 486 |
<ul class="tsd-signatures tsd-kind-type-literal"> |
| 487 |
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| 488 |
</ul> |
| 489 |
<ul class="tsd-descriptions"> |
| 490 |
<li class="tsd-description"> |
| 491 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 492 |
<ul class="tsd-parameters"> |
| 493 |
<li> |
| 494 |
<h5>message: <span class="tsd-signature-type">string</span></h5> |
| 495 |
</li> |
| 496 |
<li> |
| 497 |
<h5>path: <span class="tsd-signature-type">string</span></h5> |
| 498 |
</li> |
| 499 |
</ul> |
| 500 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 501 |
</li> |
| 502 |
</ul> |
| 503 |
</li> |
| 504 |
</ul> |
| 505 |
</li> |
| 506 |
</ul> |
| 507 |
<h4 class="tsd-returns-title">Returns <a href="modules.html#optionalrequirefunction" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4> |
| 508 |
<p>required module</p> |
| 509 |
</li> |
| 510 |
</ul> |
| 511 |
</section> |
| 512 |
<section class="tsd-panel tsd-member tsd-kind-function"> |
| 513 |
<a name="setdefaultlog" class="tsd-anchor"></a> |
| 514 |
<h3>set<wbr>Default<wbr>Log</h3> |
| 515 |
<ul class="tsd-signatures tsd-kind-function"> |
| 516 |
<li class="tsd-signature tsd-kind-icon">set<wbr>Default<wbr>Log<span class="tsd-signature-symbol">(</span>log<span class="tsd-signature-symbol">: </span><a href="modules.html#logfunction" class="tsd-signature-type" data-tsd-kind="Type alias">LogFunction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| 517 |
</ul> |
| 518 |
<ul class="tsd-descriptions"> |
| 519 |
<li class="tsd-description"> |
| 520 |
<aside class="tsd-sources"> |
| 521 |
<ul> |
| 522 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L123">index.ts:123</a></li> |
| 523 |
</ul> |
| 524 |
</aside> |
| 525 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 526 |
<ul class="tsd-parameters"> |
| 527 |
<li> |
| 528 |
<h5>log: <a href="modules.html#logfunction" class="tsd-signature-type" data-tsd-kind="Type alias">LogFunction</a></h5> |
| 529 |
</li> |
| 530 |
</ul> |
| 531 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 532 |
</li> |
| 533 |
</ul> |
| 534 |
</section> |
| 535 |
<section class="tsd-panel tsd-member tsd-kind-function"> |
| 536 |
<a name="tryrequire" class="tsd-anchor"></a> |
| 537 |
<h3>try<wbr>Require</h3> |
| 538 |
<ul class="tsd-signatures tsd-kind-function"> |
| 539 |
<li class="tsd-signature tsd-kind-icon">try<wbr>Require<span class="tsd-signature-symbol">(</span>callerRequire<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeRequire</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, optsOrMsg<span class="tsd-signature-symbol">?: </span><a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li> |
| 540 |
</ul> |
| 541 |
<ul class="tsd-descriptions"> |
| 542 |
<li class="tsd-description"> |
| 543 |
<aside class="tsd-sources"> |
| 544 |
<ul> |
| 545 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L187">index.ts:187</a></li> |
| 546 |
</ul> |
| 547 |
</aside> |
| 548 |
<div class="tsd-comment tsd-typography"> |
| 549 |
<div class="lead"> |
| 550 |
<p>try to require a module with optional handling in case it's not found or fail to require</p> |
| 551 |
</div> |
| 552 |
</div> |
| 553 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 554 |
<ul class="tsd-parameters"> |
| 555 |
<li> |
| 556 |
<h5>callerRequire: <span class="tsd-signature-type">NodeRequire</span></h5> |
| 557 |
<div class="tsd-comment tsd-typography"> |
| 558 |
<p><code>require</code> from caller context</p> |
| 559 |
</div> |
| 560 |
</li> |
| 561 |
<li> |
| 562 |
<h5>path: <span class="tsd-signature-type">string</span></h5> |
| 563 |
<div class="tsd-comment tsd-typography"> |
| 564 |
<p>path to module to require</p> |
| 565 |
</div> |
| 566 |
</li> |
| 567 |
<li> |
| 568 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> optsOrMsg: <a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5> |
| 569 |
<div class="tsd-comment tsd-typography"> |
| 570 |
<p>options or message to log in case of exceptions</p> |
| 571 |
</div> |
| 572 |
</li> |
| 573 |
</ul> |
| 574 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4> |
| 575 |
<p>require result</p> |
| 576 |
</li> |
| 577 |
</ul> |
| 578 |
</section> |
| 579 |
<section class="tsd-panel tsd-member tsd-kind-function"> |
| 580 |
<a name="tryresolve" class="tsd-anchor"></a> |
| 581 |
<h3>try<wbr>Resolve</h3> |
| 582 |
<ul class="tsd-signatures tsd-kind-function"> |
| 583 |
<li class="tsd-signature tsd-kind-icon">try<wbr>Resolve<span class="tsd-signature-symbol">(</span>callerRequire<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeRequire</span>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, optsOrMsg<span class="tsd-signature-symbol">?: </span><a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> |
| 584 |
</ul> |
| 585 |
<ul class="tsd-descriptions"> |
| 586 |
<li class="tsd-description"> |
| 587 |
<aside class="tsd-sources"> |
| 588 |
<ul> |
| 589 |
<li>Defined in <a href="https://github.com/jchip/optional-require/blob/0d1c5168/src/index.ts#L205">index.ts:205</a></li> |
| 590 |
</ul> |
| 591 |
</aside> |
| 592 |
<div class="tsd-comment tsd-typography"> |
| 593 |
<div class="lead"> |
| 594 |
<p>try to resolve a module with optional handling in case it's not found or fail to require</p> |
| 595 |
</div> |
| 596 |
</div> |
| 597 |
<h4 class="tsd-parameters-title">Parameters</h4> |
| 598 |
<ul class="tsd-parameters"> |
| 599 |
<li> |
| 600 |
<h5>callerRequire: <span class="tsd-signature-type">NodeRequire</span></h5> |
| 601 |
<div class="tsd-comment tsd-typography"> |
| 602 |
<p><code>require</code> from caller context</p> |
| 603 |
</div> |
| 604 |
</li> |
| 605 |
<li> |
| 606 |
<h5>path: <span class="tsd-signature-type">string</span></h5> |
| 607 |
<div class="tsd-comment tsd-typography"> |
| 608 |
<p>path to module to require</p> |
| 609 |
</div> |
| 610 |
</li> |
| 611 |
<li> |
| 612 |
<h5><span class="tsd-flag ts-flagOptional">Optional</span> optsOrMsg: <a href="modules.html#optionalrequireopts" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalRequireOpts</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5> |
| 613 |
<div class="tsd-comment tsd-typography"> |
| 614 |
<p>options or message to log in case of exceptions</p> |
| 615 |
</div> |
| 616 |
</li> |
| 617 |
</ul> |
| 618 |
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> |
| 619 |
<p>resolve result</p> |
| 620 |
</li> |
| 621 |
</ul> |
| 622 |
</section> |
| 623 |
</section> |
| 624 |
</div> |
| 625 |
<div class="col-4 col-menu menu-sticky-wrap menu-highlight"> |
| 626 |
<nav class="tsd-navigation primary"> |
| 627 |
<ul> |
| 628 |
<li class="current "> |
| 629 |
<a href="modules.html">Exports</a> |
| 630 |
</li> |
| 631 |
</ul> |
| 632 |
</nav> |
| 633 |
<nav class="tsd-navigation secondary menu-sticky"> |
| 634 |
<ul class="before-current"> |
| 635 |
<li class=" tsd-kind-type-alias"> |
| 636 |
<a href="modules.html#logfunction" class="tsd-kind-icon">Log<wbr>Function</a> |
| 637 |
</li> |
| 638 |
<li class=" tsd-kind-type-alias tsd-has-type-parameter"> |
| 639 |
<a href="modules.html#optionalrequirefunction" class="tsd-kind-icon">Optional<wbr>Require<wbr>Function</a> |
| 640 |
</li> |
| 641 |
<li class=" tsd-kind-type-alias"> |
| 642 |
<a href="modules.html#optionalrequireopts" class="tsd-kind-icon">Optional<wbr>Require<wbr>Opts</a> |
| 643 |
</li> |
| 644 |
<li class=" tsd-kind-variable"> |
| 645 |
<a href="modules.html#optionalrequire" class="tsd-kind-icon">optional<wbr>Require</a> |
| 646 |
</li> |
| 647 |
<li class=" tsd-kind-variable"> |
| 648 |
<a href="modules.html#optionalrequirecwd" class="tsd-kind-icon">optional<wbr>Require<wbr>Cwd</a> |
| 649 |
</li> |
| 650 |
<li class=" tsd-kind-function tsd-has-type-parameter"> |
| 651 |
<a href="modules.html#makeoptionalrequire" class="tsd-kind-icon">make<wbr>Optional<wbr>Require</a> |
| 652 |
</li> |
| 653 |
<li class=" tsd-kind-function"> |
| 654 |
<a href="modules.html#setdefaultlog" class="tsd-kind-icon">set<wbr>Default<wbr>Log</a> |
| 655 |
</li> |
| 656 |
<li class=" tsd-kind-function"> |
| 657 |
<a href="modules.html#tryrequire" class="tsd-kind-icon">try<wbr>Require</a> |
| 658 |
</li> |
| 659 |
<li class=" tsd-kind-function"> |
| 660 |
<a href="modules.html#tryresolve" class="tsd-kind-icon">try<wbr>Resolve</a> |
| 661 |
</li> |
| 662 |
</ul> |
| 663 |
</nav> |
| 664 |
</div> |
| 665 |
</div> |
| 666 |
</div> |
| 667 |
<footer class="with-border-bottom"> |
| 668 |
<div class="container"> |
| 669 |
<h2>Legend</h2> |
| 670 |
<div class="tsd-legend-group"> |
| 671 |
</div> |
| 672 |
</div> |
| 673 |
</footer> |
| 674 |
<div class="container tsd-generator"> |
| 675 |
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> |
| 676 |
</div> |
| 677 |
<div class="overlay"></div> |
| 678 |
<script src="assets/js/main.js"></script> |
| 679 |
</body> |
| 680 |
</html> |