123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <title> useProfile</title>
- <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
- <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
- <script src="./build/entry.js"></script>
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
- <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
- <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
- <link type="text/css" rel="stylesheet" href="styles/app.min.css">
- <link type="text/css" rel="stylesheet" href="styles/iframe.css">
- <link type="text/css" rel="stylesheet" href="">
- <script async defer src="https://buttons.github.io/buttons.js"></script>
-
- </head>
- <body class="layout small-header">
- <div id="stickyNavbarOverlay"></div>
-
- <div class="top-nav">
- <div class="inner">
- <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
- <span aria-hidden="true"></span>
- <span aria-hidden="true"></span>
- <span aria-hidden="true"></span>
- </a>
- <div class="logo">
-
-
- </div>
- <div class="menu">
-
- <div class="navigation">
- <a
- href="index.html"
- class="link"
- >
- API Documentation
- </a>
-
-
-
- </div>
- </div>
- </div>
- </div>
- <div id="main">
- <div
- class="sidebar "
- id="sidebarNav"
- >
-
- <nav>
-
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Interfaces</h3><ul><li><a href="AddLandmarkProps.html">AddLandmarkProps</a></li><li><a href="CommentProps.html">CommentProps</a></li><li><a href="IdToken.html">IdToken</a></li><li><a href="IntroProps.html">IntroProps</a></li><li><a href="Landmark.html">Landmark</a></li><li><a href="LandmarkDetailsProps.html">LandmarkDetailsProps</a></li><li><a href="LandmarkPinProps.html">LandmarkPinProps</a></li><li><a href="LMComment.html">LMComment</a></li><li><a href="ProfileProps.html">ProfileProps</a></li><li><a href="RegisterProps.html">RegisterProps</a></li><li><a href="UserProfile.html">UserProfile</a></li></ul><h3>Components</h3><ul><li><a href="App.html">App</a></li><li><a href="Atlas.html">Atlas</a></li><li><a href="Comment.html">Comment</a></li><li><a href="PrimaryButton.html">PrimaryButton</a></li><li><a href="Profile.html">Profile</a></li><li><a href="SecondaryButton.html">SecondaryButton</a></li></ul><h3>Global</h3><ul><li><a href="global.html#IconStrings">IconStrings</a></li></ul></div><div class="category"><h2>Hooks</h2><h3>Namespaces</h3><ul><li><a href="useAuth.html">useAuth</a></li><li><a href="useLandmarks.html">useLandmarks</a></li><li><a href="useProfile.html">useProfile</a></li></ul></div><div class="category"><h2>Map</h2><h3>Interfaces</h3><ul><li><a href="UserLocation.html">UserLocation</a></li></ul><h3>Components</h3><ul><li><a href="AddLandmark.html">AddLandmark</a></li><li><a href="LandmarkDetails.html">LandmarkDetails</a></li><li><a href="LandmarkPin.html">LandmarkPin</a></li><li><a href="Map.html">Map</a></li></ul></div><div class="category"><h2>Navigation</h2><h3>Components</h3><ul><li><a href="AuthorizedNavigator.html">AuthorizedNavigator</a></li><li><a href="UnauthorizedNavigator.html">UnauthorizedNavigator</a></li></ul><h3><a href="global.html">Global</a></h3></div><div class="category"><h2>Stores</h2><h3>Classes</h3><ul><li><a href="AuthStore.html">AuthStore</a></li></ul></div><div class="category"><h2>Unauthorized</h2><h3>Components</h3><ul><li><a href="Intro.html">Intro</a></li><li><a href="UnauthorizedLayout.html">UnauthorizedLayout</a></li></ul><h3>Components / Registration</h3><ul><li><a href="RegisterMain.html">RegisterMain</a></li></ul></div>
-
- </nav>
- </div>
- <div class="core" id="main-content-wrapper">
- <div class="content">
- <header class="page-title">
- <p>Namespace</p>
- <h1>useProfile</h1>
- </header>
-
- <section>
- <header>
-
- <h2>useProfile</h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
- <div class="description"><p>A custom hook containing <a href="https://react-query.tanstack.com/">react-query</a> queries and mutations and other logic related to interacting with <a href="UserProfile.html">UserProfile</a> objects.</p></div>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_hooks_useProfile.ts.html" class="button">View Source</a>
- <span>
- <a href="src_hooks_useProfile.ts.html">src/hooks/useProfile.ts</a>, <a href="src_hooks_useProfile.ts.html#line8">line 8</a>
- </span>
- </p>
-
- </dl>
-
-
- </div>
-
-
-
-
-
-
-
-
-
- <div class='vertical-section'>
- <h1>Methods</h1>
- <div class="members">
-
- <div class="member">
-
- <h4 class="name" id="~getProfile">
- <a class="href-link" href="#~getProfile">#</a>
-
-
- <span class='tag'>async</span>
-
- <span class='tag'>inner</span>
-
-
- <span class="code-name">
-
- getProfile<span class="signature">()</span><span class="type-signature"></span>
-
- </span>
- </h4>
-
-
-
- <div class="description">
- <p>The callback responsible for retrieving the <a href="Profile.html">Profile</a> matching the given ID from the API , used by the <a href="https://react-query.tanstack.com/reference/useQuery#_top">react-query useQuery</a> hook.</p>
- <ul>
- <li>@memberOf useProfile</li>
- </ul>
- </div>
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <p class="tag-source">
- <a href="src_hooks_useProfile.ts.html" class="button">View Source</a>
- <span>
- <a href="src_hooks_useProfile.ts.html">src/hooks/useProfile.ts</a>, <a href="src_hooks_useProfile.ts.html#line31">line 31</a>
- </span>
- </p>
-
- </dl>
- </div>
-
- </div>
- </div>
-
-
-
- </article>
- </section>
- </div>
-
- <footer class="footer">
- <div class="content has-text-centered">
- <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a></p>
- <p class="sidebar-created-by">
- <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
- <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
- </p>
- </div>
- </footer>
-
- </div>
- <div id="side-nav" class="side-nav">
- </div>
- </div>
- <script src="scripts/app.min.js"></script>
- <script>PR.prettyPrint();</script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|