kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-05-15 17:37:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
0719b1c752adf60c13bbe86b6cd24a93adddff35
stacks.js/docs/interfaces/auth.sessionoptions.html
Reed Rosenbluth 0719b1c752 chore: update root package version, build docs
2021-05-12 10:23:59 -04:00

337 lines
15 KiB
HTML
Vendored
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SessionOptions | Stacks.js 1.4.1 Library Reference</title>
<meta name="description" content="Documentation for Stacks.js 1.4.1 Library Reference">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<link rel="stylesheet" href="../assets/css/custom-style.css">
<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">Stacks.js 1.4.1 Library Reference</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>
</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="../modules.html">Stacks.js 1.4.1 Library Reference</a>
</li>
<li>
<a href="../modules/auth.html">auth</a>
</li>
<li>
<a href="auth.sessionoptions.html">SessionOptions</a>
</li>
</ul>
<h1>Interface SessionOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SessionOptions</span>
</li>
</ul>
</section>
<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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="auth.sessionoptions.html#corenode" class="tsd-kind-icon">core<wbr>Node</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="auth.sessionoptions.html#etags" class="tsd-kind-icon">etags</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="auth.sessionoptions.html#localstoragekey" class="tsd-kind-icon">local<wbr>Storage<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="auth.sessionoptions.html#storeoptions" class="tsd-kind-icon">store<wbr>Options</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="auth.sessionoptions.html#transitkey" class="tsd-kind-icon">transit<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="auth.sessionoptions.html#userdata" class="tsd-kind-icon">user<wbr>Data</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="corenode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> core<wbr>Node</h3>
<div class="tsd-signature tsd-kind-icon">core<wbr>Node<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/sessionData.ts#L9">packages/auth/src/sessionData.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="etags" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> etags</h3>
<div class="tsd-signature tsd-kind-icon">etags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EtagMap</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/sessionData.ts#L12">packages/auth/src/sessionData.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="localstoragekey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> local<wbr>Storage<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">local<wbr>Storage<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/sessionData.ts#L13">packages/auth/src/sessionData.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="storeoptions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> store<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">store<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>localStorageKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/sessionData.ts#L14">packages/auth/src/sessionData.ts:14</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> local<wbr>Storage<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transitkey" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transit<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">transit<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/sessionData.ts#L11">packages/auth/src/sessionData.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="userdata" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">user<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type" data-tsd-kind="Interface">UserData</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/sessionData.ts#L10">packages/auth/src/sessionData.ts:10</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/auth.html">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/transactions.html">transactions</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/auth.html" class="tsd-kind-icon">auth</a>
<ul>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/auth.html#profilelookupoptions" class="tsd-kind-icon">Profile<wbr>Lookup<wbr>Options</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/auth.html#userdata" class="tsd-kind-icon">User<wbr>Data</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/auth.html#usersession" class="tsd-kind-icon">User<wbr>Session</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/auth.html#lookupprofile" class="tsd-kind-icon">lookup<wbr>Profile</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/auth.html#makeauthrequest" class="tsd-kind-icon">make<wbr>Auth<wbr>Request</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/auth.authscope.html" class="tsd-kind-icon">Auth<wbr>Scope</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/auth.appconfig.html" class="tsd-kind-icon">App<wbr>Config</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/auth.sessiondatastore.html" class="tsd-kind-icon">Session<wbr>Data<wbr>Store</a>
</li>
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="auth.sessionoptions.html" class="tsd-kind-icon">Session<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="auth.sessionoptions.html#corenode" class="tsd-kind-icon">core<wbr>Node</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="auth.sessionoptions.html#etags" class="tsd-kind-icon">etags</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="auth.sessionoptions.html#localstoragekey" class="tsd-kind-icon">local<wbr>Storage<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="auth.sessionoptions.html#storeoptions" class="tsd-kind-icon">store<wbr>Options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="auth.sessionoptions.html#transitkey" class="tsd-kind-icon">transit<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="auth.sessionoptions.html#userdata" class="tsd-kind-icon">user<wbr>Data</a>
</li>
</ul>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/auth.html#default_blockstack_host" class="tsd-kind-icon">DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/auth.html#default_profile" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-module">
<a href="../modules/bns.html" class="tsd-kind-icon">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html" class="tsd-kind-icon">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html" class="tsd-kind-icon">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html" class="tsd-kind-icon">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html" class="tsd-kind-icon">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html" class="tsd-kind-icon">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html" class="tsd-kind-icon">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html" class="tsd-kind-icon">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/transactions.html" class="tsd-kind-icon">transactions</a>
</li>
</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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<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-class"><span class="tsd-kind-icon">Class</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>
Reference in New Issue View Git Blame Copy Permalink