@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>IMethodOptions | @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_http_restservice_.html">"services/http/RestService"</a> </li> <li> <a href="_services_http_restservice_.imethodoptions.html">IMethodOptions</a> </li> </ul> <h1>Interface IMethodOptions</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">IMethodOptions</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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_services_http_restservice_.imethodoptions.html#accept" class="tsd-kind-icon">accept</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_services_http_restservice_.imethodoptions.html#headers" class="tsd-kind-icon">headers</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_services_http_restservice_.imethodoptions.html#jscacheseconds" class="tsd-kind-icon">js<wbr>Cache<wbr>Seconds</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_services_http_restservice_.imethodoptions.html#jsonoptions" class="tsd-kind-icon">json<wbr>Options</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_services_http_restservice_.imethodoptions.html#returnheaders" class="tsd-kind-icon">return<wbr>Headers</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="accept" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> accept</h3> <div class="tsd-signature tsd-kind-icon">accept<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/web-atoms/core/blob/8e9453e/src/services/http/RestService.ts#L35">src/services/http/RestService.ts:35</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Accept header, application/json if not set</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="headers" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3> <div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.ihttpheaders.html" class="tsd-signature-type">IHttpHeaders</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/http/RestService.ts#L40">src/services/http/RestService.ts:40</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Other headers to pass along with the request</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="jscacheseconds" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> js<wbr>Cache<wbr>Seconds</h3> <div class="tsd-signature tsd-kind-icon">js<wbr>Cache<wbr>Seconds<span class="tsd-signature-symbol">:</span> <a href="../modules/_services_cacheservice_.html#cacheseconds" class="tsd-signature-type">CacheSeconds</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/http/RestService.ts#L30">src/services/http/RestService.ts:30</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Cache value retrieved from server in JavaScript runtime for given seconds</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="jsonoptions" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> json<wbr>Options</h3> <div class="tsd-signature tsd-kind-icon">json<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="_services_jsonservice_.ijsonparseroptions.html" class="tsd-signature-type">IJsonParserOptions</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/http/RestService.ts#L46">src/services/http/RestService.ts:46</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>JsonService options to use with this request, use this only if naming strategy is different for this request</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="returnheaders" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> return<wbr>Headers</h3> <div class="tsd-signature tsd-kind-icon">return<wbr>Headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/web-atoms/core/blob/8e9453e/src/services/http/RestService.ts#L52">src/services/http/RestService.ts:52</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>If you want to inspect response headers, pass this true, but make sure you have return type as IApiResponse<T></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> <li class="current tsd-kind-external-module"> <a href="../modules/_services_http_restservice_.html">"services/http/<wbr>Rest<wbr>Service"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="../classes/_services_http_restservice_.baseservice.html" class="tsd-kind-icon">Base<wbr>Service</a> </li> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="../classes/_services_http_restservice_.serviceparameter.html" class="tsd-kind-icon">Service<wbr>Parameter</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter"> <a href="_services_http_restservice_.iapiresponse.html" class="tsd-kind-icon">IApi<wbr>Response</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_services_http_restservice_.ihttpheaders.html" class="tsd-kind-icon">IHttp<wbr>Headers</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-external-module"> <a href="_services_http_restservice_.imethodoptions.html" class="tsd-kind-icon">IMethod<wbr>Options</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_services_http_restservice_.imethodoptions.html#accept" class="tsd-kind-icon">accept</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_services_http_restservice_.imethodoptions.html#headers" class="tsd-kind-icon">headers</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_services_http_restservice_.imethodoptions.html#jscacheseconds" class="tsd-kind-icon">js<wbr>Cache<wbr>Seconds</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_services_http_restservice_.imethodoptions.html#jsonoptions" class="tsd-kind-icon">json<wbr>Options</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_services_http_restservice_.imethodoptions.html#returnheaders" class="tsd-kind-icon">return<wbr>Headers</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#restattr" class="tsd-kind-icon">Rest<wbr>Attr</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#restmethodattr" class="tsd-kind-icon">Rest<wbr>Method<wbr>Attr</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#restparamattr" class="tsd-kind-icon">Rest<wbr>Param<wbr>Attr</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#body" class="tsd-kind-icon">Body</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#bodyformmodel" class="tsd-kind-icon">Body<wbr>Form<wbr>Model</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#delete" class="tsd-kind-icon">Delete</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#get" class="tsd-kind-icon">Get</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#header" class="tsd-kind-icon">Header</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#patch" class="tsd-kind-icon">Patch</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#path" class="tsd-kind-icon">Path</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#post" class="tsd-kind-icon">Post</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#put" class="tsd-kind-icon">Put</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#queries" class="tsd-kind-icon">Queries</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#query" class="tsd-kind-icon">Query</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#rawbody" class="tsd-kind-icon">Raw<wbr>Body</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#xmlbody" class="tsd-kind-icon">Xml<wbr>Body</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#baseurl" class="tsd-kind-icon">Base<wbr>Url</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="../modules/_services_http_restservice_.html#cancel" class="tsd-kind-icon">Cancel</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>