зеркало из https://github.com/microsoft/paris.git
981 строка
64 KiB
HTML
981 строка
64 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>Paris</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">Paris</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-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>
|
|
</ul>
|
|
<h1> Paris</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<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>Enumerations</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-enum"><a href="enums/dataavailability.html" class="tsd-kind-icon">Data<wbr>Availability</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/dataquerysortdirection.html" class="tsd-kind-icon">Data<wbr>Query<wbr>Sort<wbr>Direction</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/entityerrortypes.html" class="tsd-kind-icon">Entity<wbr>Error<wbr>Types</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/entitygetmethod.html" class="tsd-kind-icon">Entity<wbr>Get<wbr>Method</a></li>
|
|
<li class="tsd-kind-enum"><a href="enums/relationshiptype.html" class="tsd-kind-icon">Relationship<wbr>Type</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/apicallmodel.html" class="tsd-kind-icon">Api<wbr>Call<wbr>Model</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/datacache.html" class="tsd-kind-icon">Data<wbr>Cache</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/datastoreservice.html" class="tsd-kind-icon">Data<wbr>Store<wbr>Service</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/datatransformersservice.html" class="tsd-kind-icon">Data<wbr>Transformers<wbr>Service</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/entitiesservice.html" class="tsd-kind-icon">Entities<wbr>Service</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/entitiesservicebase.html" class="tsd-kind-icon">Entities<wbr>Service<wbr>Base</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/entityconfigbase.html" class="tsd-kind-icon">Entity<wbr>Config<wbr>Base</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/entityfieldsservice.html" class="tsd-kind-icon">Entity<wbr>Fields<wbr>Service</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/entitymodelbase.html" class="tsd-kind-icon">Entity<wbr>Model<wbr>Base</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/entityrelationshipsservice.html" class="tsd-kind-icon">Entity<wbr>Relationships<wbr>Service</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/errorsservice.html" class="tsd-kind-icon">Errors<wbr>Service</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/http.html" class="tsd-kind-icon">Http</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/immutability.html" class="tsd-kind-icon">Immutability</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/modelbase.html" class="tsd-kind-icon">Model<wbr>Base</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/modelentity.html" class="tsd-kind-icon">Model<wbr>Entity</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/modeler.html" class="tsd-kind-icon">Modeler</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/paris.html" class="tsd-kind-icon">Paris</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/readonlyrepository.html" class="tsd-kind-icon">Readonly<wbr>Repository</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/relationshiprepository.html" class="tsd-kind-icon">Relationship<wbr>Repository</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/repository.html" class="tsd-kind-icon">Repository</a></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/valueobjectsservice.html" class="tsd-kind-icon">Value<wbr>Objects<wbr>Service</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Interfaces</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-interface"><a href="interfaces/ajaxservice.html" class="tsd-kind-icon">Ajax<wbr>Service</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/apicallbackendconfiginterface.html" class="tsd-kind-icon">Api<wbr>Call<wbr>Backend<wbr>Config<wbr>Interface</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/apicallconfig.html" class="tsd-kind-icon">Api<wbr>Call<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/apicalltype.html" class="tsd-kind-icon">Api<wbr>Call<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/datacachesettings.html" class="tsd-kind-icon">Data<wbr>Cache<wbr>Settings</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/dataentitytype.html" class="tsd-kind-icon">Data<wbr>Entity<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/dataoptions.html" class="tsd-kind-icon">Data<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/dataquery.html" class="tsd-kind-icon">Data<wbr>Query</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/dataquerysortfield.html" class="tsd-kind-icon">Data<wbr>Query<wbr>Sort<wbr>Field</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/dataset.html" class="tsd-kind-icon">Data<wbr>Set</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/datatransformer.html" class="tsd-kind-icon">Data<wbr>Transformer</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/entitybackendconfig.html" class="tsd-kind-icon">Entity<wbr>Backend<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/entityconfig.html" class="tsd-kind-icon">Entity<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/entityerrorevent.html" class="tsd-kind-icon">Entity<wbr>Error<wbr>Event</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/entityevent.html" class="tsd-kind-icon">Entity<wbr>Event</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/entitymodelconfigbase.html" class="tsd-kind-icon">Entity<wbr>Model<wbr>Config<wbr>Base</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/entityrelationshipconfig.html" class="tsd-kind-icon">Entity<wbr>Relationship<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/entityrelationshiprepositorytype.html" class="tsd-kind-icon">Entity<wbr>Relationship<wbr>Repository<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/field.html" class="tsd-kind-icon">Field</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/fieldconfig.html" class="tsd-kind-icon">Field<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/httpoptions.html" class="tsd-kind-icon">Http<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ientityconfigbase.html" class="tsd-kind-icon">IEntity<wbr>Config<wbr>Base</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ientityrelationshiprepositorytype.html" class="tsd-kind-icon">IEntity<wbr>Relationship<wbr>Repository<wbr>Type</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ireadonlyrepository.html" class="tsd-kind-icon">IReadonly<wbr>Repository</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/irelationshiprepository.html" class="tsd-kind-icon">IRelationship<wbr>Repository</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/irepository.html" class="tsd-kind-icon">IRepository</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/modelconfig.html" class="tsd-kind-icon">Model<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/modelentitycacheconfig.html" class="tsd-kind-icon">Model<wbr>Entity<wbr>Cache<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/parisconfig.html" class="tsd-kind-icon">Paris<wbr>Config</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/removeentitiesevent.html" class="tsd-kind-icon">Remove<wbr>Entities<wbr>Event</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/requestdata.html" class="tsd-kind-icon">Request<wbr>Data</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/saveentityevent.html" class="tsd-kind-icon">Save<wbr>Entity<wbr>Event</a></li>
|
|
<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/saveitems.html" class="tsd-kind-icon">Save<wbr>Items</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Type aliases</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#datasetoptionssort" class="tsd-kind-icon">Data<wbr>Set<wbr>Options<wbr>Sort</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#entityconfigfunctionorvalue" class="tsd-kind-icon">Entity<wbr>Config<wbr>Function<wbr>OrValue</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#entityfieldconfigfunctionorvalue" class="tsd-kind-icon">Entity<wbr>Field<wbr>Config<wbr>Function<wbr>OrValue</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#entityfields" class="tsd-kind-icon">Entity<wbr>Fields</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#entityid" class="tsd-kind-icon">Entity<wbr>Id</a></li>
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter tsd-is-not-exported"><a href="globals.html#modelpropertyvalue" class="tsd-kind-icon">Model<wbr>Property<wbr>Value</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#requestmethod" class="tsd-kind-icon">Request<wbr>Method</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#saverequestmethod" class="tsd-kind-icon">Save<wbr>Request<wbr>Method</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="globals.html#urlparams" class="tsd-kind-icon">Url<wbr>Params</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Variables</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#default_all_items_property" class="tsd-kind-icon">DEFAULT_<wbr>ALL_<wbr>ITEMS_<wbr>PROPERTY</a></li>
|
|
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#default_id_property" class="tsd-kind-icon">DEFAULT_<wbr>ID_<wbr>PROPERTY</a></li>
|
|
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#default_relationship_types" class="tsd-kind-icon">DEFAULT_<wbr>RELATIONSHIP_<wbr>TYPES</a></li>
|
|
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#default_timeout" class="tsd-kind-icon">DEFAULT_<wbr>TIMEOUT</a></li>
|
|
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#default_value_id" class="tsd-kind-icon">DEFAULT_<wbr>VALUE_<wbr>ID</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#field_data_self" class="tsd-kind-icon">FIELD_<wbr>DATA_<wbr>SELF</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#entitiesservice" class="tsd-kind-icon">entities<wbr>Service</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#entityfieldsservice" class="tsd-kind-icon">entity<wbr>Fields<wbr>Service</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#entityrelationshipsservice" class="tsd-kind-icon">entity<wbr>Relationships<wbr>Service</a></li>
|
|
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#transformers" class="tsd-kind-icon">transformers</a></li>
|
|
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#transformersmap" class="tsd-kind-icon">transformers<wbr>Map</a></li>
|
|
<li class="tsd-kind-variable"><a href="globals.html#valueobjectsservice" class="tsd-kind-icon">value<wbr>Objects<wbr>Service</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function"><a href="globals.html#apicall" class="tsd-kind-icon">Api<wbr>Call</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#entity" class="tsd-kind-icon">Entity</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#entityfield" class="tsd-kind-icon">Entity<wbr>Field</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#entityrelationship" class="tsd-kind-icon">Entity<wbr>Relationship</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#valueobject" class="tsd-kind-icon">Value<wbr>Object</a></li>
|
|
<li class="tsd-kind-function"><a href="globals.html#querytohttpoptions" class="tsd-kind-icon">query<wbr>ToHttp<wbr>Options</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Object literals</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#defaultconfig" class="tsd-kind-icon">default<wbr>Config</a></li>
|
|
<li class="tsd-kind-object-literal"><a href="globals.html#defaultdataoptions" class="tsd-kind-icon">default<wbr>Data<wbr>Options</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Type aliases</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="datasetoptionssort" class="tsd-anchor"></a>
|
|
<h3>Data<wbr>Set<wbr>Options<wbr>Sort</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Data<wbr>Set<wbr>Options<wbr>Sort<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="interfaces/dataquerysortfield.html" class="tsd-signature-type">DataQuerySortField</a><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/data-query-sort.ts#L1">data_access/data-query-sort.ts:1</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="entityconfigfunctionorvalue" class="tsd-anchor"></a>
|
|
<h3>Entity<wbr>Config<wbr>Function<wbr>OrValue</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Entity<wbr>Config<wbr>Function<wbr>OrValue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span><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/microsoft/paris/blob/87d6e18/lib/config/entity.config.ts#L172">config/entity.config.ts:172</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="entityfieldconfigfunctionorvalue" class="tsd-anchor"></a>
|
|
<h3>Entity<wbr>Field<wbr>Config<wbr>Function<wbr>OrValue</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Entity<wbr>Field<wbr>Config<wbr>Function<wbr>OrValue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span><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/microsoft/paris/blob/87d6e18/lib/config/entity-field.config.ts#L153">config/entity-field.config.ts:153</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="entityfields" class="tsd-anchor"></a>
|
|
<h3>Entity<wbr>Fields</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Entity<wbr>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="interfaces/field.html" class="tsd-signature-type">Field</a><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/api/entity/entity-fields.ts#L3">api/entity/entity-fields.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="entityid" class="tsd-anchor"></a>
|
|
<h3>Entity<wbr>Id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Entity<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/modeling/entity-id.type.ts#L1">modeling/entity-id.type.ts:1</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter tsd-is-not-exported">
|
|
<a name="modelpropertyvalue" class="tsd-anchor"></a>
|
|
<h3>Model<wbr>Property<wbr>Value</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Model<wbr>Property<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/modeling/modeler.ts#L372">modeling/modeler.ts:372</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="requestmethod" class="tsd-anchor"></a>
|
|
<h3>Request<wbr>Method</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Request<wbr>Method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"GET"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"DELETE"</span><span class="tsd-signature-symbol"> | </span><a href="globals.html#saverequestmethod" class="tsd-signature-type">SaveRequestMethod</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/http.service.ts#L8">data_access/http.service.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="saverequestmethod" class="tsd-anchor"></a>
|
|
<h3>Save<wbr>Request<wbr>Method</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Save<wbr>Request<wbr>Method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"POST"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PUT"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"PATCH"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/http.service.ts#L7">data_access/http.service.ts:7</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
<a name="urlparams" class="tsd-anchor"></a>
|
|
<h3>Url<wbr>Params</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Url<wbr>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/http.service.ts#L119">data_access/http.service.ts:119</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-index-signature">
|
|
<h5><span class="tsd-signature-symbol">[</span>index: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Variables</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
|
<a name="default_all_items_property" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>ALL_<wbr>ITEMS_<wbr>PROPERTY</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>ALL_<wbr>ITEMS_<wbr>PROPERTY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"items"</span><span class="tsd-signature-symbol"> = "items"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/modeling/modeler.ts#L19">modeling/modeler.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
|
<a name="default_id_property" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>ID_<wbr>PROPERTY</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>ID_<wbr>PROPERTY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"id"</span><span class="tsd-signature-symbol"> = "id"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/model-config.ts#L10">config/model-config.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
|
<a name="default_relationship_types" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>RELATIONSHIP_<wbr>TYPES</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>RELATIONSHIP_<wbr>TYPES<span class="tsd-signature-symbol">:</span> <a href="enums/relationshiptype.html" class="tsd-signature-type">RelationshipType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [RelationshipType.OneToMany, RelationshipType.OneToOne]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/api/repository/relationship-repository.ts#L16">api/repository/relationship-repository.ts:16</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
|
<a name="default_timeout" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>TIMEOUT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>TIMEOUT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">60000</span><span class="tsd-signature-symbol"> = 60000</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/http.service.ts#L9">data_access/http.service.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
|
<a name="default_value_id" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>VALUE_<wbr>ID</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>VALUE_<wbr>ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"__default"</span><span class="tsd-signature-symbol"> = "__default"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/model-config.ts#L11">config/model-config.ts:11</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="field_data_self" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> FIELD_<wbr>DATA_<wbr>SELF</h3>
|
|
<div class="tsd-signature tsd-kind-icon">FIELD_<wbr>DATA_<wbr>SELF<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"__self"</span><span class="tsd-signature-symbol"> = "__self"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/entity-field.config.ts#L152">config/entity-field.config.ts:152</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="entitiesservice" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> entities<wbr>Service</h3>
|
|
<div class="tsd-signature tsd-kind-icon">entities<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="classes/entitiesservice.html" class="tsd-signature-type">EntitiesService</a><span class="tsd-signature-symbol"> = new EntitiesService()</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/services/entities.service.ts#L6">config/services/entities.service.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="entityfieldsservice" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> entity<wbr>Fields<wbr>Service</h3>
|
|
<div class="tsd-signature tsd-kind-icon">entity<wbr>Fields<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="classes/entityfieldsservice.html" class="tsd-signature-type">EntityFieldsService</a><span class="tsd-signature-symbol"> = new EntityFieldsService</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/services/entity-fields.service.ts#L21">config/services/entity-fields.service.ts:21</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="entityrelationshipsservice" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> entity<wbr>Relationships<wbr>Service</h3>
|
|
<div class="tsd-signature tsd-kind-icon">entity<wbr>Relationships<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="classes/entityrelationshipsservice.html" class="tsd-signature-type">EntityRelationshipsService</a><span class="tsd-signature-symbol"> = new EntityRelationshipsService</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/services/entity-relationships.service.ts#L33">config/services/entity-relationships.service.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
|
<a name="transformers" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> transformers</h3>
|
|
<div class="tsd-signature tsd-kind-icon">transformers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="interfaces/datatransformer.html" class="tsd-signature-type">DataTransformer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = [{type: Date,parse: (dateValue:string) => new Date(dateValue),serialize: (date:Date) => date ? date.toISOString() : null},{type: RegExp,parse: (pattern:string) => new RegExp(pattern),serialize: (regExp:RegExp) => regExp ? regExp.toString().match(/^\/(.*)\/$/)[1] : null}]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/modeling/data-transformers.service.ts#L1">modeling/data-transformers.service.ts:1</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
|
<a name="transformersmap" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> transformers<wbr>Map</h3>
|
|
<div class="tsd-signature tsd-kind-icon">transformers<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">, </span><a href="interfaces/datatransformer.html" class="tsd-signature-type">DataTransformer</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/modeling/data-transformers.service.ts#L14">modeling/data-transformers.service.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable">
|
|
<a name="valueobjectsservice" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> value<wbr>Objects<wbr>Service</h3>
|
|
<div class="tsd-signature tsd-kind-icon">value<wbr>Objects<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="classes/valueobjectsservice.html" class="tsd-signature-type">ValueObjectsService</a><span class="tsd-signature-symbol"> = new ValueObjectsService</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/services/value-objects.service.ts#L6">config/services/value-objects.service.ts:6</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="apicall" class="tsd-anchor"></a>
|
|
<h3>Api<wbr>Call</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">Api<wbr>Call<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="interfaces/apicallconfig.html" class="tsd-signature-type">ApiCallConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/decorators/api-call.decorator.ts#L3">config/decorators/api-call.decorator.ts:3</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>config: <a href="interfaces/apicallconfig.html" class="tsd-signature-type">ApiCallConfig</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="entity" class="tsd-anchor"></a>
|
|
<h3>Entity</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">Entity<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="interfaces/entityconfig.html" class="tsd-signature-type">EntityConfig</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/decorators/entity.decorator.ts#L5">config/decorators/entity.decorator.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>config: <a href="interfaces/entityconfig.html" class="tsd-signature-type">EntityConfig</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="entityfield" class="tsd-anchor"></a>
|
|
<h3>Entity<wbr>Field</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">Entity<wbr>Field<span class="tsd-signature-symbol">(</span>fieldConfig<span class="tsd-signature-symbol">?: </span><a href="interfaces/fieldconfig.html" class="tsd-signature-type">FieldConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropertyDecorator</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/decorators/entity-field.decorator.ts#L12">config/decorators/entity-field.decorator.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>All properties of models (Entity/ValueObject) that should be handled by Paris should be decorated with <code>EntityField</code>.
|
|
When Paris creates an instance of a model, it maps the raw data arrived from backend to class properties, through EntityFields.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fieldConfig: <a href="interfaces/fieldconfig.html" class="tsd-signature-type">FieldConfig</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PropertyDecorator</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="entityrelationship" class="tsd-anchor"></a>
|
|
<h3>Entity<wbr>Relationship</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">Entity<wbr>Relationship<span class="tsd-signature-symbol">(</span>entityRelationshipConfig<span class="tsd-signature-symbol">: </span><a href="interfaces/entityrelationshipconfig.html" class="tsd-signature-type">EntityRelationshipConfig</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/decorators/entity-relationship.decorator.ts#L4">config/decorators/entity-relationship.decorator.ts:4</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>entityRelationshipConfig: <a href="interfaces/entityrelationshipconfig.html" class="tsd-signature-type">EntityRelationshipConfig</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="valueobject" class="tsd-anchor"></a>
|
|
<h3>Value<wbr>Object</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">Value<wbr>Object<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="interfaces/ientityconfigbase.html" class="tsd-signature-type">IEntityConfigBase</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/decorators/value-object.decorator.ts#L5">config/decorators/value-object.decorator.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>config: <a href="interfaces/ientityconfigbase.html" class="tsd-signature-type">IEntityConfigBase</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function">
|
|
<a name="querytohttpoptions" class="tsd-anchor"></a>
|
|
<h3>query<wbr>ToHttp<wbr>Options</h3>
|
|
<ul class="tsd-signatures tsd-kind-function">
|
|
<li class="tsd-signature tsd-kind-icon">query<wbr>ToHttp<wbr>Options<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">?: </span><a href="interfaces/dataquery.html" class="tsd-signature-type">DataQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/httpoptions.html" class="tsd-signature-type">HttpOptions</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/query-to-http.ts#L5">data_access/query-to-http.ts:5</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> query: <a href="interfaces/dataquery.html" class="tsd-signature-type">DataQuery</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="interfaces/httpoptions.html" class="tsd-signature-type">HttpOptions</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Object literals</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="defaultconfig" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Config</h3>
|
|
<div class="tsd-signature tsd-kind-icon">default<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/paris-config.ts#L17">config/paris-config.ts:17</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="defaultconfig.allitemsproperty" class="tsd-anchor"></a>
|
|
<h3>all<wbr>Items<wbr>Property</h3>
|
|
<div class="tsd-signature tsd-kind-icon">all<wbr>Items<wbr>Property<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "items"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/paris-config.ts#L18">config/paris-config.ts:18</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="defaultconfig.entityidproperty" class="tsd-anchor"></a>
|
|
<h3>entity<wbr>IdProperty</h3>
|
|
<div class="tsd-signature tsd-kind-icon">entity<wbr>IdProperty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "id"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/config/paris-config.ts#L19">config/paris-config.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-object-literal">
|
|
<a name="defaultdataoptions" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Data<wbr>Options</h3>
|
|
<div class="tsd-signature tsd-kind-icon">default<wbr>Data<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/data.options.ts#L18">data_access/data.options.ts:18</a></li>
|
|
</ul>
|
|
</aside>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="defaultdataoptions.allowcache" class="tsd-anchor"></a>
|
|
<h3>allow<wbr>Cache</h3>
|
|
<div class="tsd-signature tsd-kind-icon">allow<wbr>Cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/data.options.ts#L19">data_access/data.options.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
|
<a name="defaultdataoptions.availability" class="tsd-anchor"></a>
|
|
<h3>availability</h3>
|
|
<div class="tsd-signature tsd-kind-icon">availability<span class="tsd-signature-symbol">:</span> <a href="enums/dataavailability.html#deep" class="tsd-signature-type">deep</a><span class="tsd-signature-symbol"> = DataAvailability.deep</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/microsoft/paris/blob/87d6e18/lib/data_access/data.options.ts#L20">data_access/data.options.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals current ">
|
|
<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">
|
|
<a href="enums/dataavailability.html" class="tsd-kind-icon">Data<wbr>Availability</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/dataquerysortdirection.html" class="tsd-kind-icon">Data<wbr>Query<wbr>Sort<wbr>Direction</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/entityerrortypes.html" class="tsd-kind-icon">Entity<wbr>Error<wbr>Types</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/entitygetmethod.html" class="tsd-kind-icon">Entity<wbr>Get<wbr>Method</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/relationshiptype.html" class="tsd-kind-icon">Relationship<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/apicallmodel.html" class="tsd-kind-icon">Api<wbr>Call<wbr>Model</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/datacache.html" class="tsd-kind-icon">Data<wbr>Cache</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/datastoreservice.html" class="tsd-kind-icon">Data<wbr>Store<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/datatransformersservice.html" class="tsd-kind-icon">Data<wbr>Transformers<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/entitiesservice.html" class="tsd-kind-icon">Entities<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/entitiesservicebase.html" class="tsd-kind-icon">Entities<wbr>Service<wbr>Base</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/entityconfigbase.html" class="tsd-kind-icon">Entity<wbr>Config<wbr>Base</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/entityfieldsservice.html" class="tsd-kind-icon">Entity<wbr>Fields<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/entitymodelbase.html" class="tsd-kind-icon">Entity<wbr>Model<wbr>Base</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/entityrelationshipsservice.html" class="tsd-kind-icon">Entity<wbr>Relationships<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/errorsservice.html" class="tsd-kind-icon">Errors<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/http.html" class="tsd-kind-icon">Http</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/immutability.html" class="tsd-kind-icon">Immutability</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/modelbase.html" class="tsd-kind-icon">Model<wbr>Base</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/modelentity.html" class="tsd-kind-icon">Model<wbr>Entity</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/modeler.html" class="tsd-kind-icon">Modeler</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/paris.html" class="tsd-kind-icon">Paris</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/readonlyrepository.html" class="tsd-kind-icon">Readonly<wbr>Repository</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/relationshiprepository.html" class="tsd-kind-icon">Relationship<wbr>Repository</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/repository.html" class="tsd-kind-icon">Repository</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
<a href="classes/valueobjectsservice.html" class="tsd-kind-icon">Value<wbr>Objects<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/ajaxservice.html" class="tsd-kind-icon">Ajax<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/apicallbackendconfiginterface.html" class="tsd-kind-icon">Api<wbr>Call<wbr>Backend<wbr>Config<wbr>Interface</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/apicallconfig.html" class="tsd-kind-icon">Api<wbr>Call<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/apicalltype.html" class="tsd-kind-icon">Api<wbr>Call<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/datacachesettings.html" class="tsd-kind-icon">Data<wbr>Cache<wbr>Settings</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/dataentitytype.html" class="tsd-kind-icon">Data<wbr>Entity<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/dataoptions.html" class="tsd-kind-icon">Data<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/dataquery.html" class="tsd-kind-icon">Data<wbr>Query</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/dataquerysortfield.html" class="tsd-kind-icon">Data<wbr>Query<wbr>Sort<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/dataset.html" class="tsd-kind-icon">Data<wbr>Set</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/datatransformer.html" class="tsd-kind-icon">Data<wbr>Transformer</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/entitybackendconfig.html" class="tsd-kind-icon">Entity<wbr>Backend<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/entityconfig.html" class="tsd-kind-icon">Entity<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/entityerrorevent.html" class="tsd-kind-icon">Entity<wbr>Error<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/entityevent.html" class="tsd-kind-icon">Entity<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/entitymodelconfigbase.html" class="tsd-kind-icon">Entity<wbr>Model<wbr>Config<wbr>Base</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/entityrelationshipconfig.html" class="tsd-kind-icon">Entity<wbr>Relationship<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/entityrelationshiprepositorytype.html" class="tsd-kind-icon">Entity<wbr>Relationship<wbr>Repository<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/field.html" class="tsd-kind-icon">Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/fieldconfig.html" class="tsd-kind-icon">Field<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/httpoptions.html" class="tsd-kind-icon">Http<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/ientityconfigbase.html" class="tsd-kind-icon">IEntity<wbr>Config<wbr>Base</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/ientityrelationshiprepositorytype.html" class="tsd-kind-icon">IEntity<wbr>Relationship<wbr>Repository<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/ireadonlyrepository.html" class="tsd-kind-icon">IReadonly<wbr>Repository</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/irelationshiprepository.html" class="tsd-kind-icon">IRelationship<wbr>Repository</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/irepository.html" class="tsd-kind-icon">IRepository</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/modelconfig.html" class="tsd-kind-icon">Model<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/modelentitycacheconfig.html" class="tsd-kind-icon">Model<wbr>Entity<wbr>Cache<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
<a href="interfaces/parisconfig.html" class="tsd-kind-icon">Paris<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/removeentitiesevent.html" class="tsd-kind-icon">Remove<wbr>Entities<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/requestdata.html" class="tsd-kind-icon">Request<wbr>Data</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/saveentityevent.html" class="tsd-kind-icon">Save<wbr>Entity<wbr>Event</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-is-not-exported">
|
|
<a href="interfaces/saveitems.html" class="tsd-kind-icon">Save<wbr>Items</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#datasetoptionssort" class="tsd-kind-icon">Data<wbr>Set<wbr>Options<wbr>Sort</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#entityconfigfunctionorvalue" class="tsd-kind-icon">Entity<wbr>Config<wbr>Function<wbr>OrValue</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#entityfieldconfigfunctionorvalue" class="tsd-kind-icon">Entity<wbr>Field<wbr>Config<wbr>Function<wbr>OrValue</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#entityfields" class="tsd-kind-icon">Entity<wbr>Fields</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#entityid" class="tsd-kind-icon">Entity<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter tsd-is-not-exported">
|
|
<a href="globals.html#modelpropertyvalue" class="tsd-kind-icon">Model<wbr>Property<wbr>Value</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#requestmethod" class="tsd-kind-icon">Request<wbr>Method</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#saverequestmethod" class="tsd-kind-icon">Save<wbr>Request<wbr>Method</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#urlparams" class="tsd-kind-icon">Url<wbr>Params</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-is-not-exported">
|
|
<a href="globals.html#default_all_items_property" class="tsd-kind-icon">DEFAULT_<wbr>ALL_<wbr>ITEMS_<wbr>PROPERTY</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-is-not-exported">
|
|
<a href="globals.html#default_id_property" class="tsd-kind-icon">DEFAULT_<wbr>ID_<wbr>PROPERTY</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-is-not-exported">
|
|
<a href="globals.html#default_relationship_types" class="tsd-kind-icon">DEFAULT_<wbr>RELATIONSHIP_<wbr>TYPES</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-is-not-exported">
|
|
<a href="globals.html#default_timeout" class="tsd-kind-icon">DEFAULT_<wbr>TIMEOUT</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-is-not-exported">
|
|
<a href="globals.html#default_value_id" class="tsd-kind-icon">DEFAULT_<wbr>VALUE_<wbr>ID</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#field_data_self" class="tsd-kind-icon">FIELD_<wbr>DATA_<wbr>SELF</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#entitiesservice" class="tsd-kind-icon">entities<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#entityfieldsservice" class="tsd-kind-icon">entity<wbr>Fields<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#entityrelationshipsservice" class="tsd-kind-icon">entity<wbr>Relationships<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-is-not-exported">
|
|
<a href="globals.html#transformers" class="tsd-kind-icon">transformers</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-is-not-exported">
|
|
<a href="globals.html#transformersmap" class="tsd-kind-icon">transformers<wbr>Map</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#valueobjectsservice" class="tsd-kind-icon">value<wbr>Objects<wbr>Service</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#apicall" class="tsd-kind-icon">Api<wbr>Call</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#entity" class="tsd-kind-icon">Entity</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#entityfield" class="tsd-kind-icon">Entity<wbr>Field</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#entityrelationship" class="tsd-kind-icon">Entity<wbr>Relationship</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#valueobject" class="tsd-kind-icon">Value<wbr>Object</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#querytohttpoptions" class="tsd-kind-icon">query<wbr>ToHttp<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#defaultconfig" class="tsd-kind-icon">default<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-object-literal">
|
|
<a href="globals.html#defaultdataoptions" class="tsd-kind-icon">default<wbr>Data<wbr>Options</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>
|
|
</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="http://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> |