th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
6f59639efc8cdb0833f3ec59a16cacf2f93cc1ea
pyShelf/docs/pyShelf/html/d8/def/classobjects_1_1JSInterface.html

158 lines
8.0 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: objects.JSInterface Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">pyShelf Open Source Ebook Server<span id="projectnumber">&#160;0.8.0</span>
</div>
<div id="projectbrief">FOSS E-Book Server, https://pyshelf.com</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<div id="main-nav">
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
<li><a href="../../files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="../../classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="../../functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- main-nav -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a href="../../df/d4c/namespaceobjects.html">objects</a></li><li class="navelem"><a href="../../d8/def/classobjects_1_1JSInterface.html">JSInterface</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d2/dcb/classobjects_1_1JSInterface-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">objects.JSInterface Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aff3d033ea502f8e991b787161606f52a" id="r_aff3d033ea502f8e991b787161606f52a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff3d033ea502f8e991b787161606f52a">__init__</a> (self, Config config)</td></tr>
<tr class="memitem:a1e1c0b95d04fa6932bbac992f0e2806b" id="r_a1e1c0b95d04fa6932bbac992f0e2806b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e1c0b95d04fa6932bbac992f0e2806b">install</a> (self)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acc2370a364bb1ecdc297c25fff39cbc9" id="r_acc2370a364bb1ecdc297c25fff39cbc9"><td class="memItemLeft" align="right" valign="top">Path&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc2370a364bb1ecdc297c25fff39cbc9">package_json</a> = Path(config.root, &quot;src/frontend/package.json&quot;)</td></tr>
<tr class="memitem:a9f74685909b540934f577227f0a4086a" id="r_a9f74685909b540934f577227f0a4086a"><td class="memItemLeft" align="right" valign="top">Config&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f74685909b540934f577227f0a4086a">config</a> = config</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">A class to interface with the JavaScript side of pyShelf.</pre> </div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aff3d033ea502f8e991b787161606f52a" name="aff3d033ea502f8e991b787161606f52a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff3d033ea502f8e991b787161606f52a">&#9670;&#160;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">objects.JSInterface.__init__ </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Config</td> <td class="paramname"><span class="paramname"><em>config</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Initialize the JSInterface object.</pre>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a1e1c0b95d04fa6932bbac992f0e2806b" name="a1e1c0b95d04fa6932bbac992f0e2806b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e1c0b95d04fa6932bbac992f0e2806b">&#9670;&#160;</a></span>install()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">objects.JSInterface.install </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Install the JavaScript dependencies.</pre>
</div>
</div>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="a9f74685909b540934f577227f0a4086a" name="a9f74685909b540934f577227f0a4086a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f74685909b540934f577227f0a4086a">&#9670;&#160;</a></span>config</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Config objects.JSInterface.config = config</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acc2370a364bb1ecdc297c25fff39cbc9" name="acc2370a364bb1ecdc297c25fff39cbc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc2370a364bb1ecdc297c25fff39cbc9">&#9670;&#160;</a></span>package_json</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Path objects.JSInterface.package_json = Path(config.root, &quot;src/frontend/package.json&quot;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/frontend/lib/<a class="el" href="">objects.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on <span class="timestamp"></span> for pyShelf Open Source Ebook Server by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink