| <!doctype html> |
| <html class="no-js" lang=""> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="x-ua-compatible" content="ie=edge"> |
| <title>helix-front documentation</title> |
| <meta name="description" content=""> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| |
| <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> |
| <link rel="stylesheet" href="../styles/style.css"> |
| <link rel="stylesheet" href="../styles/dark.css"> |
| </head> |
| <body> |
| |
| <div class="navbar navbar-default navbar-fixed-top visible-xs"> |
| <a href="../" class="navbar-brand">helix-front documentation</a> |
| <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> |
| </div> |
| |
| <div class="xs-menu menu" id="mobile-menu"> |
| <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> |
| </div> |
| |
| <div class="container-fluid main"> |
| <div class="row main"> |
| <div class="hidden-xs menu"> |
| <compodoc-menu mode="normal"></compodoc-menu> |
| </div> |
| <!-- START CONTENT --> |
| <div class="content interface"> |
| <div class="content-data"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <ol class="breadcrumb"> |
| <li>Interfaces</li> |
| <li |
| > |
| HelixSession</li> |
| </ol> |
| |
| <ul class="nav nav-tabs" role="tablist"> |
| <li class="active"> |
| <a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a> |
| </li> |
| <li > |
| <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a> |
| </li> |
| </ul> |
| |
| <div class="tab-content"> |
| <div class="tab-pane fade active in" id="c-info"> |
| <p class="comment"> |
| <h3>File</h3> |
| </p> |
| <p class="comment"> |
| <code>server/controllers/d.ts</code> |
| </p> |
| |
| |
| |
| |
| <section> |
| <h3 id="index">Index</h3> |
| <table class="table table-sm table-bordered index-table"> |
| <tbody> |
| <tr> |
| <td class="col-md-4"> |
| <h6><b>Properties</b></h6> |
| </td> |
| </tr> |
| <tr> |
| <td class="col-md-4"> |
| <ul class="index-list"> |
| <li> |
| <a href="#identityToken" |
| > |
| identityToken |
| </a> |
| </li> |
| <li> |
| <a href="#isAdmin" |
| > |
| isAdmin |
| </a> |
| </li> |
| <li> |
| <a href="#username" |
| > |
| username |
| </a> |
| </li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| |
| |
| |
| <section> |
| <h3 id="inputs">Properties</h3> |
| <table class="table table-sm table-bordered"> |
| <tbody> |
| <tr> |
| <td class="col-md-4"> |
| <a name="identityToken"></a> |
| <span class="name "><b>identityToken</b> |
| <a href="#identityToken"> |
| <span class="icon ion-ios-link"></span> |
| </a> |
| </span> |
| </td> |
| </tr> |
| <tr> |
| <td class="col-md-4"> |
| <code>identityToken: <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> |
| </code> |
| </td> |
| </tr> |
| |
| |
| <tr> |
| <td class="col-md-4"> |
| <i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> |
| |
| </td> |
| </tr> |
| |
| |
| |
| |
| |
| </tbody> |
| </table> |
| <table class="table table-sm table-bordered"> |
| <tbody> |
| <tr> |
| <td class="col-md-4"> |
| <a name="isAdmin"></a> |
| <span class="name "><b>isAdmin</b> |
| <a href="#isAdmin"> |
| <span class="icon ion-ios-link"></span> |
| </a> |
| </span> |
| </td> |
| </tr> |
| <tr> |
| <td class="col-md-4"> |
| <code>isAdmin: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> |
| </code> |
| </td> |
| </tr> |
| |
| |
| <tr> |
| <td class="col-md-4"> |
| <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> |
| |
| </td> |
| </tr> |
| |
| |
| |
| |
| |
| </tbody> |
| </table> |
| <table class="table table-sm table-bordered"> |
| <tbody> |
| <tr> |
| <td class="col-md-4"> |
| <a name="username"></a> |
| <span class="name "><b>username</b> |
| <a href="#username"> |
| <span class="icon ion-ios-link"></span> |
| </a> |
| </span> |
| </td> |
| </tr> |
| <tr> |
| <td class="col-md-4"> |
| <code>username: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> |
| </code> |
| </td> |
| </tr> |
| |
| |
| <tr> |
| <td class="col-md-4"> |
| <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> |
| |
| </td> |
| </tr> |
| |
| |
| |
| |
| |
| </tbody> |
| </table> |
| </section> |
| </div> |
| |
| |
| <div class="tab-pane fade tab-source-code" id="c-source"> |
| <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Request } from 'express'; |
| import request from 'request'; |
| |
| export interface HelixRequest extends Request { |
| session?: HelixSession; |
| } |
| |
| interface HelixSession { |
| // since this token is from a configurable |
| // identity source, the format really is |
| // `any` from helix-front's point of view. |
| identityToken: any; |
| username: string; |
| isAdmin: boolean; |
| } |
| |
| type AgentOptions = { |
| rejectUnauthorized: boolean; |
| ca?: string; |
| }; |
| |
| export type HelixRequestOptions = { |
| url: string; |
| json: string; |
| headers: request.Headers; |
| agentOptions: AgentOptions; |
| body?: string; |
| }; |
| </code></pre> |
| </div> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| </div><div class="search-results"> |
| <div class="has-results"> |
| <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> |
| <ul class="search-results-list"></ul> |
| </div> |
| <div class="no-results"> |
| <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> |
| </div> |
| </div> |
| </div> |
| <!-- END CONTENT --> |
| </div> |
| </div> |
| |
| <label class="dark-mode-switch"> |
| <input type="checkbox"> |
| <span class="slider"> |
| <svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg"> |
| <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path> |
| </svg> |
| </span> |
| </label> |
| |
| <script> |
| var COMPODOC_CURRENT_PAGE_DEPTH = 1; |
| var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface'; |
| var COMPODOC_CURRENT_PAGE_URL = 'HelixSession.html'; |
| var MAX_SEARCH_RESULTS = 15; |
| </script> |
| |
| <script src="../js/libs/custom-elements.min.js"></script> |
| <script src="../js/libs/lit-html.js"></script> |
| |
| <script src="../js/menu-wc.js" defer></script> |
| <script nomodule src="../js/menu-wc_es5.js" defer></script> |
| |
| <script src="../js/libs/bootstrap-native.js"></script> |
| |
| <script src="../js/libs/es6-shim.min.js"></script> |
| <script src="../js/libs/EventDispatcher.js"></script> |
| <script src="../js/libs/promise.min.js"></script> |
| <script src="../js/libs/zepto.min.js"></script> |
| |
| <script src="../js/compodoc.js"></script> |
| |
| <script src="../js/tabs.js"></script> |
| <script src="../js/menu.js"></script> |
| <script src="../js/libs/clipboard.min.js"></script> |
| <script src="../js/libs/prism.js"></script> |
| <script src="../js/sourceCode.js"></script> |
| <script src="../js/search/search.js"></script> |
| <script src="../js/search/lunr.min.js"></script> |
| <script src="../js/search/search-lunr.js"></script> |
| <script src="../js/search/search_index.js"></script> |
| <script src="../js/lazy-load-graphs.js"></script> |
| |
| |
| </body> |
| </html> |
