@web-atoms/core-docs

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>JsonService | @web-atoms/core</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">@web-atoms/core</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_services_jsonservice_.html">"services/JsonService"</a> </li> <li> <a href="_services_jsonservice_.jsonservice.html">JsonService</a> </li> </ul> <h1>Class JsonService</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">JsonService</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_services_jsonservice_.jsonservice.html#parse" class="tsd-kind-icon">parse</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_services_jsonservice_.jsonservice.html#stringify" class="tsd-kind-icon">stringify</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_services_jsonservice_.jsonservice.html#transformkeys" class="tsd-kind-icon">transform<wbr>Keys</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-class"><a href="_services_jsonservice_.jsonservice.html#options" class="tsd-kind-icon">options</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="parse" class="tsd-anchor"></a> <h3>parse</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">parse<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_services_jsonservice_.ijsonparseroptions.html" class="tsd-signature-type">IJsonParserOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/JsonService.ts#L94">src/services/JsonService.ts:94</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>text: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_services_jsonservice_.ijsonparseroptions.html" class="tsd-signature-type">IJsonParserOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="stringify" class="tsd-anchor"></a> <h3>stringify</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">stringify<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_services_jsonservice_.ijsonparseroptions.html" class="tsd-signature-type">IJsonParserOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/JsonService.ts#L125">src/services/JsonService.ts:125</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>v: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_services_jsonservice_.ijsonparseroptions.html" class="tsd-signature-type">IJsonParserOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="transformkeys" class="tsd-anchor"></a> <h3>transform<wbr>Keys</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">transform<wbr>Keys<span class="tsd-signature-symbol">(</span>t<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, v<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-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/JsonService.ts#L60">src/services/JsonService.ts:60</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>t: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>ins<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>ins: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>v: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></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 tsd-parent-kind-class"> <a name="options" class="tsd-anchor"></a> <h3>options</h3> <div class="tsd-signature tsd-kind-icon">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/web-atoms/core/blob/8e9453e/src/services/JsonService.ts#L26">src/services/JsonService.ts:26</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="options.dateconverter" class="tsd-anchor"></a> <h3>date<wbr>Converter</h3> <div class="tsd-signature tsd-kind-icon">date<wbr>Converter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [{regex: dateFormatISORegEx,valueConverter: {fromSource(v: string): DateTime {const d = new DateTime(v);// if (/z$/i.test(v)) {// d.setMinutes( d.getMinutes() - timeZoneDiff );// }return d;},fromTarget(v: Date): any {return v.toISOString();}}}, {regex: dateFormatMSRegEx,valueConverter: {fromSource(v: string): DateTime {const a = dateFormatMSRegEx.exec(v);const b = a[1].split(/[-+,.]/);return new DateTime(b[0] ? +b[0] : 0 - +b[1]);},fromTarget(v: Date): any {return v.toISOString();}}}]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/JsonService.ts#L29">src/services/JsonService.ts:29</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="options.indent" class="tsd-anchor"></a> <h3>indent</h3> <div class="tsd-signature tsd-kind-icon">indent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/JsonService.ts#L27">src/services/JsonService.ts:27</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="options.namingstrategy" class="tsd-anchor"></a> <h3>naming<wbr>Strategy</h3> <div class="tsd-signature tsd-kind-icon">naming<wbr>Strategy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"none"</span><span class="tsd-signature-symbol"> = "none"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/JsonService.ts#L28">src/services/JsonService.ts:28</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 "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_services_jsonservice_.html">"services/<wbr>Json<wbr>Service"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_services_jsonservice_.jsonservice.html" class="tsd-kind-icon">Json<wbr>Service</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_services_jsonservice_.jsonservice.html#parse" class="tsd-kind-icon">parse</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_services_jsonservice_.jsonservice.html#stringify" class="tsd-kind-icon">stringify</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_services_jsonservice_.jsonservice.html#transformkeys" class="tsd-kind-icon">transform<wbr>Keys</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-class"> <a href="_services_jsonservice_.jsonservice.html#options" class="tsd-kind-icon">options</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_services_jsonservice_.ijsonparseroptions.html" class="tsd-kind-icon">IJson<wbr>Parser<wbr>Options</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_services_jsonservice_.html#jsonkeysnamingstrategy" class="tsd-kind-icon">Json<wbr>Keys<wbr>Naming<wbr>Strategy</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_jsonservice_.html#dateformatisoregex" class="tsd-kind-icon">date<wbr>FormatISOReg<wbr>Ex</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_jsonservice_.html#dateformatmsregex" class="tsd-kind-icon">date<wbr>FormatMSReg<wbr>Ex</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>