Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@siarheidudko
siarheidudko committed May 30, 2020
1 parent 2428345 commit d23cbe9
Show file tree
Hide file tree
Showing 33 changed files with 222 additions and 222 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Or from the FIREBASE project

### WARNING (Password hashes of users)

This API also returns the passwordSalt and passwordHash hashed by the Firebase Auth backend for password users if the user/service account used to generate the request OAuth access token has the firebaseauth.configs.getHashConfig permission. Otherwise the passwordHash and passwordSalt will not be set.
Firebase API also returns the passwordSalt and passwordHash hashed by the Firebase Auth backend for password users if the user/service account used to generate the request OAuth access token has the firebaseauth.configs.getHashConfig permission. Otherwise the passwordHash and passwordSalt will not be set.
[Open official firebase docs](https://firebase.google.com/docs/auth/admin/manage-users#password_hashes_of_listed_users)

## LICENSE
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/_firebaseengine_.firebaseengine.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/FirebaseEngine.ts#L8">FirebaseEngine.ts:8</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L8">FirebaseEngine.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -152,7 +152,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> admin</h3>
<div class="tsd-signature tsd-kind-icon">admin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">App</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/FirebaseEngine.ts#L25">FirebaseEngine.ts:25</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L25">FirebaseEngine.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -167,7 +167,7 @@ <h3>jobs</h3>
<div class="tsd-signature tsd-kind-icon">jobs<span class="tsd-signature-symbol">:</span> <a href="_jobs_jobs_.jobs.html" class="tsd-signature-type">Jobs</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/FirebaseEngine.ts#L29">FirebaseEngine.ts:29</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L29">FirebaseEngine.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -182,7 +182,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> settings</h3>
<div class="tsd-signature tsd-kind-icon">settings<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_utils_initialization_.settings.html" class="tsd-signature-type">Settings</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/FirebaseEngine.ts#L21">FirebaseEngine.ts:21</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L21">FirebaseEngine.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -204,7 +204,7 @@ <h3>exit</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/FirebaseEngine.ts#L33">FirebaseEngine.ts:33</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L33">FirebaseEngine.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
22 changes: 11 additions & 11 deletions docs/classes/_jobs_backup_auth_.jobbackupauth.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/auth.ts#L9">jobs/backup/auth.ts:9</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/auth.ts#L9">jobs/backup/auth.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -166,7 +166,7 @@ <h3>admin</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobtemplate.html">JobTemplate</a>.<a href="_utils_template_.jobtemplate.html#admin">admin</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L28">utils/template.ts:28</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L28">utils/template.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -181,7 +181,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> auth</h3>
<div class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Auth.Auth</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/auth.ts#L21">jobs/backup/auth.ts:21</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/auth.ts#L21">jobs/backup/auth.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -197,7 +197,7 @@ <h3>counter</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#counter">counter</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L80">utils/template.ts:80</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L80">utils/template.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -213,7 +213,7 @@ <h3>settings</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobtemplate.html">JobTemplate</a>.<a href="_utils_template_.jobtemplate.html#settings">settings</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L24">utils/template.ts:24</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L24">utils/template.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -229,7 +229,7 @@ <h3>start<wbr>Timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#starttimestamp">startTimestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L95">utils/template.ts:95</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L95">utils/template.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -245,7 +245,7 @@ <h3>stringifer<wbr>Stream</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#stringiferstream">stringiferStream</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L128">utils/template.ts:128</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L128">utils/template.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -261,7 +261,7 @@ <h3>writer</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#writer">writer</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L124">utils/template.ts:124</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L124">utils/template.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -284,7 +284,7 @@ <h3>get<wbr>Work<wbr>Time</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#getworktime">getWorkTime</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L84">utils/template.ts:84</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L84">utils/template.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -306,7 +306,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> recursive<wbr>Backup</h
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/auth.ts#L25">jobs/backup/auth.ts:25</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/auth.ts#L25">jobs/backup/auth.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -335,7 +335,7 @@ <h3>run</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/auth.ts#L51">jobs/backup/auth.ts:51</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/auth.ts#L51">jobs/backup/auth.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
24 changes: 12 additions & 12 deletions docs/classes/_jobs_backup_firestore_.jobbackupfirestore.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/firestore.ts#L9">jobs/backup/firestore.ts:9</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L9">jobs/backup/firestore.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -167,7 +167,7 @@ <h3>admin</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobtemplate.html">JobTemplate</a>.<a href="_utils_template_.jobtemplate.html#admin">admin</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L28">utils/template.ts:28</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L28">utils/template.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -183,7 +183,7 @@ <h3>counter</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#counter">counter</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L80">utils/template.ts:80</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L80">utils/template.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -198,7 +198,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> firestore</h3>
<div class="tsd-signature tsd-kind-icon">firestore<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Firestore.Firestore</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/firestore.ts#L21">jobs/backup/firestore.ts:21</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L21">jobs/backup/firestore.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -214,7 +214,7 @@ <h3>settings</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobtemplate.html">JobTemplate</a>.<a href="_utils_template_.jobtemplate.html#settings">settings</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L24">utils/template.ts:24</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L24">utils/template.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -230,7 +230,7 @@ <h3>start<wbr>Timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#starttimestamp">startTimestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L95">utils/template.ts:95</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L95">utils/template.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -246,7 +246,7 @@ <h3>stringifer<wbr>Stream</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#stringiferstream">stringiferStream</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L128">utils/template.ts:128</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L128">utils/template.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -262,7 +262,7 @@ <h3>writer</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#writer">writer</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L124">utils/template.ts:124</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L124">utils/template.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -284,7 +284,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> document<wbr>Backup</h3
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/firestore.ts#L25">jobs/backup/firestore.ts:25</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L25">jobs/backup/firestore.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -313,7 +313,7 @@ <h3>get<wbr>Work<wbr>Time</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#getworktime">getWorkTime</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/utils/template.ts#L84">utils/template.ts:84</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L84">utils/template.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -335,7 +335,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> recursive<wbr>Backup</h
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/firestore.ts#L49">jobs/backup/firestore.ts:49</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L49">jobs/backup/firestore.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -364,7 +364,7 @@ <h3>run</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/a0f016e/src/jobs/backup/firestore.ts#L63">jobs/backup/firestore.ts:63</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L63">jobs/backup/firestore.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit d23cbe9

Please sign in to comment.