Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@hideokamoto
hideokamoto committed Nov 7, 2019
1 parent 506c98b commit 0f724ed
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 37 deletions.
32 changes: 16 additions & 16 deletions docs/classes/_index_.cloudfrontupdator.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L85">index.ts:85</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L85">index.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -155,7 +155,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> allow<wbr>Sensitive
<div class="tsd-signature tsd-kind-icon">allow<wbr>Sensitive<wbr>Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L82">index.ts:82</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L82">index.ts:82</a></li>
</ul>
</aside>
</section>
Expand All @@ -165,7 +165,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> cf<wbr>Client</h3>
<div class="tsd-signature tsd-kind-icon">cf<wbr>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CloudFront</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L67">index.ts:67</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L67">index.ts:67</a></li>
</ul>
</aside>
</section>
Expand All @@ -175,7 +175,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> debug<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">debug<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L70">index.ts:70</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L70">index.ts:70</a></li>
</ul>
</aside>
</section>
Expand All @@ -185,7 +185,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> diff</h3>
<div class="tsd-signature tsd-kind-icon">diff<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L85">index.ts:85</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L85">index.ts:85</a></li>
</ul>
</aside>
</section>
Expand All @@ -195,7 +195,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> log</h3>
<div class="tsd-signature tsd-kind-icon">log<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L64">index.ts:64</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L64">index.ts:64</a></li>
</ul>
</aside>
</section>
Expand All @@ -205,7 +205,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> task<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">task<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../modules/_index_.interfaces.html#tasktype" class="tsd-signature-type">TaskType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L79">index.ts:79</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L79">index.ts:79</a></li>
</ul>
</aside>
</section>
Expand All @@ -215,7 +215,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> updator</h3>
<div class="tsd-signature tsd-kind-icon">updator<span class="tsd-signature-symbol">:</span> <a href="../modules/_index_.interfaces.html#updatorfunction" class="tsd-signature-type">UpdatorFunction</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L73">index.ts:73</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L73">index.ts:73</a></li>
</ul>
</aside>
</section>
Expand All @@ -232,7 +232,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> filter</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L76">index.ts:76</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L76">index.ts:76</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">true</span></h4>
Expand All @@ -249,7 +249,7 @@ <h3>get<wbr>Diff</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L147">index.ts:147</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L150">index.ts:150</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -271,7 +271,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> is<wbr>Target<wbr>D
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L184">index.ts:184</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L187">index.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -301,7 +301,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> list<wbr>All<wbr>Di
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L193">index.ts:193</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L196">index.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -334,7 +334,7 @@ <h3>update<wbr>All<wbr>Distribution</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L225">index.ts:225</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L228">index.ts:228</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -356,7 +356,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> update<wbr>Cloud<wb
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L158">index.ts:158</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L161">index.ts:161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -395,7 +395,7 @@ <h3>update<wbr>Distribution</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L212">index.ts:212</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L215">index.ts:215</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -428,7 +428,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> update<wbr>Distribu
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L110">index.ts:110</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L110">index.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ <h3>Debug / Dry run</h3>

<span class="hljs-keyword">const</span> client = <span class="hljs-keyword">new</span> CloudFrontUpdator({
<span class="hljs-comment">// You can define your expected the Distribution config</span>
updator: <span class="hljs-function">(<span class="hljs-params">id, DistributionConfig</span>) =&gt;</span> {
updator: <span class="hljs-function">(<span class="hljs-params">{id, arn}, DistributionConfig</span>) =&gt;</span> {
DistributionConfig.HttpVersion = <span class="hljs-string">'http2'</span>
<span class="hljs-keyword">return</span> DistributionConfig
},
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_index_.interfaces.clients.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3>cf<wbr>Client</h3>
<div class="tsd-signature tsd-kind-icon">cf<wbr>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CloudFront</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L33">index.ts:33</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L33">index.ts:33</a></li>
</ul>
</aside>
</section>
Expand All @@ -112,7 +112,7 @@ <h3>logger</h3>
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L34">index.ts:34</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L34">index.ts:34</a></li>
</ul>
</aside>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/_index_.interfaces.config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h3>allow<wbr>Sensitive<wbr>Action</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Sensitive<wbr>Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L42">index.ts:42</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L42">index.ts:42</a></li>
</ul>
</aside>
</section>
Expand All @@ -113,7 +113,7 @@ <h3>debug<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">debug<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L39">index.ts:39</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L39">index.ts:39</a></li>
</ul>
</aside>
</section>
Expand All @@ -123,7 +123,7 @@ <h3>task<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">task<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../modules/_index_.interfaces.html#tasktype" class="tsd-signature-type">TaskType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L40">index.ts:40</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L40">index.ts:40</a></li>
</ul>
</aside>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/_index_.interfaces.workers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> filter</h3>
<div class="tsd-signature tsd-kind-icon">filter<span class="tsd-signature-symbol">:</span> <a href="../modules/_index_.interfaces.html#filtercondition" class="tsd-signature-type">FilterCondition</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L28">index.ts:28</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L28">index.ts:28</a></li>
</ul>
</aside>
</section>
Expand All @@ -112,7 +112,7 @@ <h3>updator</h3>
<div class="tsd-signature tsd-kind-icon">updator<span class="tsd-signature-symbol">:</span> <a href="../modules/_index_.interfaces.html#updatorfunction" class="tsd-signature-type">UpdatorFunction</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L27">index.ts:27</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L27">index.ts:27</a></li>
</ul>
</aside>
</section>
Expand Down
16 changes: 8 additions & 8 deletions docs/modules/_index_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> sleep</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L11">index.ts:11</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L11">index.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -132,7 +132,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Clients</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Clients<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L53">index.ts:53</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L53">index.ts:53</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
Expand All @@ -141,7 +141,7 @@ <h3>cf<wbr>Client</h3>
<div class="tsd-signature tsd-kind-icon">cf<wbr>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CloudFront</span><span class="tsd-signature-symbol"> =&nbsp;new CloudFront()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L54">index.ts:54</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L54">index.ts:54</a></li>
</ul>
</aside>
</section>
Expand All @@ -155,7 +155,7 @@ <h3>logger</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L55">index.ts:55</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L55">index.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -175,7 +175,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Config</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L57">index.ts:57</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L57">index.ts:57</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-not-exported">
Expand All @@ -184,7 +184,7 @@ <h3>allow<wbr>Sensitive<wbr>Action</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Sensitive<wbr>Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L60">index.ts:60</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L60">index.ts:60</a></li>
</ul>
</aside>
</section>
Expand All @@ -194,7 +194,7 @@ <h3>debug<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">debug<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L58">index.ts:58</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L58">index.ts:58</a></li>
</ul>
</aside>
</section>
Expand All @@ -204,7 +204,7 @@ <h3>task<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">task<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"sequential"</span><span class="tsd-signature-symbol"> =&nbsp;&quot;sequential&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/e3f6008/libs/index.ts#L59">index.ts:59</a></li>
<li>Defined in <a href="https://github.com/hideokamoto/cloudfront-updator/blob/506c98b/libs/index.ts#L59">index.ts:59</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 0f724ed

Please sign in to comment.