Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update docs #172

Merged
merged 1 commit into from
Nov 29, 2020
Merged

docs: update docs #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2,680 changes: 1 addition & 2,679 deletions docs/assets/css/main.css
View file
Open in desktop

Large diffs are not rendered by default.

52 changes: 51 additions & 1 deletion docs/assets/js/main.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file
Open in desktop

Large diffs are not rendered by default.

1,081 changes: 974 additions & 107 deletions docs/globals.html
View file
Open in desktop

Large diffs are not rendered by default.

221 changes: 152 additions & 69 deletions docs/index.html
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 7 additions & 8 deletions docs/interfaces/indicator.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>created</h3>
<div class="tsd-signature tsd-kind-icon">created<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L8">stix2/stix2.ts:8</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L8">stix2/stix2.ts:8</a></li>
</ul>
</aside>
</section>
Expand All @@ -111,7 +111,7 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L7">stix2/stix2.ts:7</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L7">stix2/stix2.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -121,7 +121,7 @@ <h3>labels</h3>
<div class="tsd-signature tsd-kind-icon">labels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L10">stix2/stix2.ts:10</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L10">stix2/stix2.ts:10</a></li>
</ul>
</aside>
</section>
Expand All @@ -131,7 +131,7 @@ <h3>modified</h3>
<div class="tsd-signature tsd-kind-icon">modified<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L9">stix2/stix2.ts:9</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L9">stix2/stix2.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -141,7 +141,7 @@ <h3>pattern</h3>
<div class="tsd-signature tsd-kind-icon">pattern<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L11">stix2/stix2.ts:11</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L11">stix2/stix2.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -151,7 +151,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L6">stix2/stix2.ts:6</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L6">stix2/stix2.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -161,7 +161,7 @@ <h3>valid_<wbr>from</h3>
<div class="tsd-signature tsd-kind-icon">valid_<wbr>from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L12">stix2/stix2.ts:12</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L12">stix2/stix2.ts:12</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -227,6 +227,5 @@ <h2>Legend</h2>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>
189 changes: 189 additions & 0 deletions docs/interfaces/options.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Options | ioc-extractor</title>
<meta name="description" content="Documentation for ioc-extractor">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ioc-extractor</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="options.html">Options</a>
</li>
</ul>
<h1>Interface Options</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Options</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="options.html#disableidn" class="tsd-kind-icon">disable<wbr>Idn</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="options.html#disablestricttld" class="tsd-kind-icon">disable<wbr>Strict<wbr>Tld</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="options.html#stix2" class="tsd-kind-icon">stix2</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="options.html#threads" class="tsd-kind-icon">threads</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="disableidn" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> disable<wbr>Idn</h3>
<div class="tsd-signature tsd-kind-icon">disable<wbr>Idn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/bin/ioc-extractor.ts#L11">bin/ioc-extractor.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="disablestricttld" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> disable<wbr>Strict<wbr>Tld</h3>
<div class="tsd-signature tsd-kind-icon">disable<wbr>Strict<wbr>Tld<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/bin/ioc-extractor.ts#L12">bin/ioc-extractor.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="stix2" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stix2</h3>
<div class="tsd-signature tsd-kind-icon">stix2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/bin/ioc-extractor.ts#L9">bin/ioc-extractor.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="threads" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> threads</h3>
<div class="tsd-signature tsd-kind-icon">threads<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/bin/ioc-extractor.ts#L10">bin/ioc-extractor.ts:10</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="options.html" class="tsd-kind-icon">Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="options.html#disableidn" class="tsd-kind-icon">disable<wbr>Idn</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="options.html#disablestricttld" class="tsd-kind-icon">disable<wbr>Strict<wbr>Tld</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="options.html#stix2" class="tsd-kind-icon">stix2</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="options.html#threads" class="tsd-kind-icon">threads</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
7 changes: 3 additions & 4 deletions docs/interfaces/stix2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h3>objects</h3>
<div class="tsd-signature tsd-kind-icon">objects<span class="tsd-signature-symbol">:</span> <a href="indicator.html" class="tsd-signature-type">Indicator</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L21">stix2/stix2.ts:21</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L21">stix2/stix2.ts:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -107,7 +107,7 @@ <h3>spec_<wbr>version</h3>
<div class="tsd-signature tsd-kind-icon">spec_<wbr>version<span class="tsd-signature-symbol">:</span> <a href="../globals.html#spec_version" class="tsd-signature-type">SPEC_VERSION</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L19">stix2/stix2.ts:19</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L19">stix2/stix2.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -117,7 +117,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../globals.html#spec_type" class="tsd-signature-type">SPEC_TYPE</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5d98a6c/src/stix2/stix2.ts#L20">stix2/stix2.ts:20</a></li>
<li>Defined in <a href="https://github.com/ninoseki/ioc-extractor/blob/5815c6d/src/stix2/stix2.ts#L20">stix2/stix2.ts:20</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -171,6 +171,5 @@ <h2>Legend</h2>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>