Skip to content

Commit

Permalink
docs: updates on workflows
Browse files Browse the repository at this point in the history 
Added information on documentation
  • Loading branch information
ADMSK\AVROGAL1 committed Apr 9, 2021
1 parent 1bed605 commit 889ec6e
Show file tree
Hide file tree
Showing 75 changed files with 2,139 additions and 1,997 deletions.
9 changes: 3 additions & 6 deletions .env-cmdrc.json
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
{
"dev": {
"DEBUG": "pw:api",
"NODE_ENV": "dev",
"CHROME_EMBEDDED": "false"
"NODE_ENV": "dev"
},
"prod": {
"DEBUG": "pw:api",
"NODE_ENV": "prod",
"CHROME_EMBEDDED": "true"
"NODE_ENV": "prod"
},
"test": {
"TZ": "utc",
"NODE_ENV": "test",
"CHROME_EMBEDDED": "false"
"NODE_ENV": "test"
}
}
2 changes: 1 addition & 1 deletion .eslintrc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
"no-extend-native": "error",
"no-implicit-globals": "error",
"no-multi-spaces": "error",
"no-invalid-this": "warn",
"no-invalid-this": "off",
"array-bracket-spacing": "error",
"block-spacing": "error",
"keyword-spacing": "error",
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linter.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ jobs:
JAVASCRIPT_DEFAULT_STYLE: prettier
DEFAULT_BRANCH: master
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
FILTER_REGEX_INCLUDE: .*(api|src|typings|docs).*
FILTER_REGEX_INCLUDE: .*(api|src|typings).*
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [0.0.0-dev](https://github.com/AlexRogalskiy/code-formats/compare/v2.0.1...v0.0.0-dev) (2021-04-08)
# [0.0.0-dev](https://github.com/AlexRogalskiy/code-formats/compare/v2.0.1...v0.0.0-dev) (2021-04-09)



Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

19 changes: 8 additions & 11 deletions docs/classes/src_browsers_basebrowsersession.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/baseBrowserSession.ts#L19">src/browsers/baseBrowserSession.ts:19</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/baseBrowserSession.ts#L24">src/browsers/baseBrowserSession.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -156,7 +156,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> browser</h3>
<div class="tsd-signature tsd-kind-icon">browser<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Browser</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/baseBrowserSession.ts#L19">src/browsers/baseBrowserSession.ts:19</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/baseBrowserSession.ts#L24">src/browsers/baseBrowserSession.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -178,7 +178,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-fl
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/baseBrowserSession.ts#L94">src/browsers/baseBrowserSession.ts:94</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/baseBrowserSession.ts#L100">src/browsers/baseBrowserSession.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -203,13 +203,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a name="createscreenshot" class="tsd-anchor"></a>
<h3>create<wbr>Screenshot</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Screenshot<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, imageOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#imageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">ImageOptions</a>, resourceOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#resourceoptions-1" class="tsd-signature-type" data-tsd-kind="Type alias">ResourceOptions</a>, pageOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#pageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">PageOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">create<wbr>Screenshot<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, imageOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#imageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">ImageOptions</a>, resourceOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#resourceoptions-1" class="tsd-signature-type" data-tsd-kind="Type alias">ResourceOptions</a>, pageOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#pageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">PageOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;load&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;domcontentloaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;networkidle0&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;networkidle2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PuppeteerLifeCycleEvent</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/baseBrowserSession.ts#L43">src/browsers/baseBrowserSession.ts:43</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/baseBrowserSession.ts#L48">src/browsers/baseBrowserSession.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -238,7 +238,7 @@ <h5>resourceOptions: <a href="../modules/typings_browser_types.html#resourceopti
</div>
</li>
<li>
<h5>pageOptions: <a href="../modules/typings_browser_types.html#pageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">PageOptions</a></h5>
<h5>pageOptions: <a href="../modules/typings_browser_types.html#pageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">PageOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;load&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;domcontentloaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;networkidle0&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;networkidle2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PuppeteerLifeCycleEvent</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>initial input <a href="../modules/typings_browser_types.html#pageoptions">PageOptions</a></p>
</div>
Expand All @@ -258,7 +258,7 @@ <h3>setup</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/baseBrowserSession.ts#L32">src/browsers/baseBrowserSession.ts:32</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/baseBrowserSession.ts#L37">src/browsers/baseBrowserSession.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -280,7 +280,7 @@ <h3>teardown</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/baseBrowserSession.ts#L84">src/browsers/baseBrowserSession.ts:84</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/baseBrowserSession.ts#L90">src/browsers/baseBrowserSession.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -357,9 +357,6 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul>
Expand Down
17 changes: 7 additions & 10 deletions docs/classes/src_browsers_browsersession.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> browser</h3>
<div class="tsd-signature tsd-kind-icon">browser<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Browser</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/browserSession.ts#L18">src/browsers/browserSession.ts:18</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/browserSession.ts#L23">src/browsers/browserSession.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -142,7 +142,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> page</h3>
<div class="tsd-signature tsd-kind-icon">page<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Page</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/browserSession.ts#L23">src/browsers/browserSession.ts:23</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/browserSession.ts#L28">src/browsers/browserSession.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -158,13 +158,13 @@ <h2>Methods</h2>
<a name="createscreenshot" class="tsd-anchor"></a>
<h3>create<wbr>Screenshot</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Screenshot<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, imageOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#imageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">ImageOptions</a>, resourceOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#resourceoptions-1" class="tsd-signature-type" data-tsd-kind="Type alias">ResourceOptions</a>, pageOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#pageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">PageOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">create<wbr>Screenshot<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, imageOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#imageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">ImageOptions</a>, resourceOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#resourceoptions-1" class="tsd-signature-type" data-tsd-kind="Type alias">ResourceOptions</a>, pageOptions<span class="tsd-signature-symbol">: </span><a href="../modules/typings_browser_types.html#pageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">PageOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;load&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;domcontentloaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;networkidle0&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;networkidle2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PuppeteerLifeCycleEvent</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/browserSession.ts#L49">src/browsers/browserSession.ts:49</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/browserSession.ts#L54">src/browsers/browserSession.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -193,7 +193,7 @@ <h5>resourceOptions: <a href="../modules/typings_browser_types.html#resourceopti
</div>
</li>
<li>
<h5>pageOptions: <a href="../modules/typings_browser_types.html#pageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">PageOptions</a></h5>
<h5>pageOptions: <a href="../modules/typings_browser_types.html#pageoptions" class="tsd-signature-type" data-tsd-kind="Type alias">PageOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;load&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;domcontentloaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;networkidle0&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;networkidle2&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PuppeteerLifeCycleEvent</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>initial input <a href="../modules/typings_browser_types.html#pageoptions">PageOptions</a></p>
</div>
Expand All @@ -213,7 +213,7 @@ <h3>setup</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/browserSession.ts#L29">src/browsers/browserSession.ts:29</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/browserSession.ts#L34">src/browsers/browserSession.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -244,7 +244,7 @@ <h3>teardown</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/0ef1311/src/browsers/browserSession.ts#L64">src/browsers/browserSession.ts:64</a></li>
<li>Defined in <a href="https://github.com/AlexRogalskiy/code-formats/blob/1bed605/src/browsers/browserSession.ts#L69">src/browsers/browserSession.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -322,9 +322,6 @@ <h2>Legend</h2>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
</ul>
Expand Down
Loading

1 comment on commit 889ec6e

@vercel
Copy link

@vercel vercel bot commented on 889ec6e Apr 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

Please sign in to comment.