Skip to content

Commit

Permalink
Added docs.
Browse files Browse the repository at this point in the history 
Added docs in order to be hosted.
  • Loading branch information
Roberto Pintos López committed Jan 5, 2020
1 parent 66b9d32 commit 568c36e
Show file tree
Hide file tree
Showing 35 changed files with 13,822 additions and 0 deletions.
2,321 changes: 2,321 additions & 0 deletions docs/api/assets/css/main.css
View file

Large diffs are not rendered by default.

Binary file added docs/api/assets/images/icons.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/api/assets/images/icons@2x.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/api/assets/images/widgets.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/api/assets/images/widgets@2x.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/api/assets/js/main.js
View file

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/api/assets/js/search.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

514 changes: 514 additions & 0 deletions docs/api/classes/antmanager.html
View file

Large diffs are not rendered by default.

336 changes: 336 additions & 0 deletions docs/api/enums/cachemode.html
View file

Large diffs are not rendered by default.

453 changes: 453 additions & 0 deletions docs/api/globals.html
View file

Large diffs are not rendered by default.

285 changes: 285 additions & 0 deletions docs/api/index.html
View file

Large diffs are not rendered by default.

307 changes: 307 additions & 0 deletions docs/api/interfaces/apigeneralconfig.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,307 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ApiGeneralConfig | AntJs API Doc</title>
<meta name="description" content="">
<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.js" 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">AntJs API Doc</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>
<li>
<a href="apigeneralconfig.html">ApiGeneralConfig</a>
</li>
</ul>
<h1>Interface ApiGeneralConfig&lt;TConfig&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TConfig<span class="tsd-signature-symbol">: </span><a href="apimodelconfig.html" class="tsd-signature-type">ApiModelConfig</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ApiGeneralConfig</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 tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="apigeneralconfig.html#default" class="tsd-kind-icon">default</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="default" class="tsd-anchor"></a>
<h3>default</h3>
<div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TConfig</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/notaphplover/ant-js/blob/66b9d32/src/api/config/api-general-config.ts#L7">api/config/api-general-config.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Default managers config.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-is-external">
<a href="../enums/cachemode.html" class="tsd-kind-icon">Cache<wbr>Mode</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter tsd-is-external">
<a href="../classes/antmanager.html" class="tsd-kind-icon">Ant<wbr>Manager</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="apigeneralconfig.html" class="tsd-kind-icon">Api<wbr>General<wbr>Config</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="apigeneralconfig.html#default" class="tsd-kind-icon">default</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="apigeneralmanager.html" class="tsd-kind-icon">Api<wbr>General<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="apimodel.html" class="tsd-kind-icon">Api<wbr>Model</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="apimodelconfig.html" class="tsd-kind-icon">Api<wbr>Model<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="apimodelmanager.html" class="tsd-kind-icon">Api<wbr>Model<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="apimultipleresultquerymanager.html" class="tsd-kind-icon">Api<wbr>Multiple<wbr>Result<wbr>Query<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="apiqueryconfig.html" class="tsd-kind-icon">Api<wbr>Query<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="apiquerymanager.html" class="tsd-kind-icon">Api<wbr>Query<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="apisingleresultquerymanager.html" class="tsd-kind-icon">Api<wbr>Single<wbr>Result<wbr>Query<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="basemodel.html" class="tsd-kind-icon">Base<wbr>Model</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="baseprimarymodelmanager.html" class="tsd-kind-icon">Base<wbr>Primary<wbr>Model<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="baseprimaryquerymanager.html" class="tsd-kind-icon">Base<wbr>Primary<wbr>Query<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="entity.html" class="tsd-kind-icon">Entity</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="keygenparams.html" class="tsd-kind-icon">Key<wbr>Gen<wbr>Params</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="model.html" class="tsd-kind-icon">Model</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="persistencydeleteoptions.html" class="tsd-kind-icon">Persistency<wbr>Delete<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="persistencysearchoptions.html" class="tsd-kind-icon">Persistency<wbr>Search<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="persistencyupdateoptions.html" class="tsd-kind-icon">Persistency<wbr>Update<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="primaryentitymanager.html" class="tsd-kind-icon">Primary<wbr>Entity<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="primaryentitymanagerbase.html" class="tsd-kind-icon">Primary<wbr>Entity<wbr>Manager<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="primarymodelmanager.html" class="tsd-kind-icon">Primary<wbr>Model<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="primaryquerymanager.html" class="tsd-kind-icon">Primary<wbr>Query<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter tsd-is-external">
<a href="querymanager.html" class="tsd-kind-icon">Query<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface tsd-is-external">
<a href="redismiddleware.html" class="tsd-kind-icon">Redis<wbr>Middleware</a>
</li>
<li class=" tsd-kind-type-alias tsd-is-external">
<a href="../globals.html#multiplequeryresult" class="tsd-kind-icon">Multiple<wbr>Query<wbr>Result</a>
</li>
<li class=" tsd-kind-type-alias tsd-is-external">
<a href="../globals.html#queryresult" class="tsd-kind-icon">Query<wbr>Result</a>
</li>
<li class=" tsd-kind-type-alias tsd-is-external">
<a href="../globals.html#singlequeryresult" class="tsd-kind-icon">Single<wbr>Query<wbr>Result</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter tsd-is-external">
<a href="../globals.html#tantquerymanager" class="tsd-kind-icon">TAnt<wbr>Query<wbr>Manager</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter tsd-is-external">
<a href="../globals.html#tmquery" class="tsd-kind-icon">TMQuery</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter tsd-is-external">
<a href="../globals.html#tquery" class="tsd-kind-icon">TQuery</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter tsd-is-external">
<a href="../globals.html#tresult" class="tsd-kind-icon">TResult</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<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-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

0 comments on commit 568c36e

Please sign in to comment.