-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tested typedoc documentation generation
- Loading branch information
1 parent
212dfaa
commit 57e77d4
Showing
56 changed files
with
11,659 additions
and
1 deletion.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,273 @@ | ||
| <!doctype html> | ||
| <html class="default no-js"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <title>firebase-hooks-react</title> | ||
| <meta name="description" content="Documentation for firebase-hooks-react"> | ||
| <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">firebase-hooks-react</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> | ||
| </ul> | ||
| <h1>firebase-hooks-react</h1> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="container container-main"> | ||
| <div class="row"> | ||
| <div class="col-8 col-content"> | ||
| <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>Modules</h3> | ||
| <ul class="tsd-index-list"> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_auth_types_authproviders_.html" class="tsd-kind-icon">"auth/auth-<wbr>types/auth<wbr>Providers"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_auth_types_useemailpassword_.html" class="tsd-kind-icon">"auth/auth-<wbr>types/use<wbr>Email<wbr>Password"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_auth_types_useemailpasswordconfirm_.html" class="tsd-kind-icon">"auth/auth-<wbr>types/use<wbr>Email<wbr>Password<wbr>Confirm"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_auth_types_useproviderpopup_.html" class="tsd-kind-icon">"auth/auth-<wbr>types/use<wbr>Provider<wbr>Popup"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_auth_types_usesignout_.html" class="tsd-kind-icon">"auth/auth-<wbr>types/use<wbr>Signout"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_index_.html" class="tsd-kind-icon">"auth/index"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_types_.html" class="tsd-kind-icon">"auth/types"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_useauth_.html" class="tsd-kind-icon">"auth/use<wbr>Auth"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_auth_user_.html" class="tsd-kind-icon">"auth/use<wbr>R"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_context_createfirebasecontext_.html" class="tsd-kind-icon">"context/<wbr>Create<wbr>Firebase<wbr>Context"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_context_firebasecontext_.html" class="tsd-kind-icon">"context/<wbr>Firebase<wbr>Context"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_context_index_.html" class="tsd-kind-icon">"context/index"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_handleerror_.html" class="tsd-kind-icon">"firestore/handle<wbr>Error"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_index_.html" class="tsd-kind-icon">"firestore/index"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_useaddfs_.html" class="tsd-kind-icon">"firestore/use<wbr>AddFS"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_usedeletefs_.html" class="tsd-kind-icon">"firestore/use<wbr>DeleteFS"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_usedeletefieldfs_.html" class="tsd-kind-icon">"firestore/use<wbr>Delete<wbr>FieldFS"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_usequery_.html" class="tsd-kind-icon">"firestore/use<wbr>Query"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_usereadcollection_.html" class="tsd-kind-icon">"firestore/use<wbr>Read<wbr>Collection"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_usereaddoc_.html" class="tsd-kind-icon">"firestore/use<wbr>Read<wbr>Doc"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_usereadfs_.html" class="tsd-kind-icon">"firestore/use<wbr>ReadFS"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_usesetfs_.html" class="tsd-kind-icon">"firestore/use<wbr>SetFS"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_useupdatefs_.html" class="tsd-kind-icon">"firestore/use<wbr>UpdateFS"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_usewritefs_.html" class="tsd-kind-icon">"firestore/use<wbr>WriteFS"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_firestore_write_types_.html" class="tsd-kind-icon">"firestore/write-<wbr>types"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_index_.html" class="tsd-kind-icon">"index"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_types_firebase_config_.html" class="tsd-kind-icon">"types/firebase/config"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_types_firebase_context_.html" class="tsd-kind-icon">"types/firebase/context"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_types_firebase_index_.html" class="tsd-kind-icon">"types/firebase/index"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_types_firebase_tech_array_.html" class="tsd-kind-icon">"types/firebase/tech-<wbr>array"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_types_firestore_data_.html" class="tsd-kind-icon">"types/firestore/data"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_types_firestore_index_.html" class="tsd-kind-icon">"types/firestore/index"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_types_firestore_params_.html" class="tsd-kind-icon">"types/firestore/params"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_types_user_type_.html" class="tsd-kind-icon">"types/user-<wbr>type"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_utils_addtimestamp_.html" class="tsd-kind-icon">"utils/add<wbr>Timestamp"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_utils_converttowithuser_.html" class="tsd-kind-icon">"utils/convert<wbr>ToWith<wbr>User"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_utils_createdummypost_.html" class="tsd-kind-icon">"utils/create<wbr>Dummy<wbr>Post"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_utils_firebasedate_.html" class="tsd-kind-icon">"utils/firebase<wbr>Date"</a></li> | ||
| <li class="tsd-kind-module"><a href="modules/_utils_isempty_.html" class="tsd-kind-icon">"utils/is<wbr>Empty"</a></li> | ||
| </ul> | ||
| </section> | ||
| </div> | ||
| </section> | ||
| </section> | ||
| </div> | ||
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> | ||
| <nav class="tsd-navigation primary"> | ||
| <ul> | ||
| <li class="globals current "> | ||
| <a href="globals.html"><em>Globals</em></a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_auth_types_authproviders_.html">"auth/auth-<wbr>types/auth<wbr>Providers"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_auth_types_useemailpassword_.html">"auth/auth-<wbr>types/use<wbr>Email<wbr>Password"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_auth_types_useemailpasswordconfirm_.html">"auth/auth-<wbr>types/use<wbr>Email<wbr>Password<wbr>Confirm"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_auth_types_useproviderpopup_.html">"auth/auth-<wbr>types/use<wbr>Provider<wbr>Popup"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_auth_types_usesignout_.html">"auth/auth-<wbr>types/use<wbr>Signout"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_index_.html">"auth/index"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_types_.html">"auth/types"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_useauth_.html">"auth/use<wbr>Auth"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_auth_user_.html">"auth/use<wbr>R"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_context_createfirebasecontext_.html">"context/<wbr>Create<wbr>Firebase<wbr>Context"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_context_firebasecontext_.html">"context/<wbr>Firebase<wbr>Context"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_context_index_.html">"context/index"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_handleerror_.html">"firestore/handle<wbr>Error"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_index_.html">"firestore/index"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_useaddfs_.html">"firestore/use<wbr>AddFS"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_usedeletefs_.html">"firestore/use<wbr>DeleteFS"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_usedeletefieldfs_.html">"firestore/use<wbr>Delete<wbr>FieldFS"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_usequery_.html">"firestore/use<wbr>Query"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_usereadcollection_.html">"firestore/use<wbr>Read<wbr>Collection"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_usereaddoc_.html">"firestore/use<wbr>Read<wbr>Doc"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_usereadfs_.html">"firestore/use<wbr>ReadFS"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_usesetfs_.html">"firestore/use<wbr>SetFS"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_useupdatefs_.html">"firestore/use<wbr>UpdateFS"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_usewritefs_.html">"firestore/use<wbr>WriteFS"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_firestore_write_types_.html">"firestore/write-<wbr>types"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_index_.html">"index"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_types_firebase_config_.html">"types/firebase/config"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_types_firebase_context_.html">"types/firebase/context"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_types_firebase_index_.html">"types/firebase/index"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_types_firebase_tech_array_.html">"types/firebase/tech-<wbr>array"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_types_firestore_data_.html">"types/firestore/data"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_types_firestore_index_.html">"types/firestore/index"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_types_firestore_params_.html">"types/firestore/params"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_types_user_type_.html">"types/user-<wbr>type"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_utils_addtimestamp_.html">"utils/add<wbr>Timestamp"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_utils_converttowithuser_.html">"utils/convert<wbr>ToWith<wbr>User"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_utils_createdummypost_.html">"utils/create<wbr>Dummy<wbr>Post"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_utils_firebasedate_.html">"utils/firebase<wbr>Date"</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="modules/_utils_isempty_.html">"utils/is<wbr>Empty"</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <nav class="tsd-navigation secondary menu-sticky"> | ||
| <ul class="before-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-variable"><span class="tsd-kind-icon">Variable</span></li> | ||
| <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> | ||
| <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> | ||
| <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> | ||
| <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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> |
Oops, something went wrong.