@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>"services/http/RestService" | @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="_services_http_restservice_.html">"services/http/RestService"</a> </li> </ul> <h1>External module "services/http/RestService"</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>Classes</h3> <ul class="tsd-index-list"> <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> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter"><a href="../interfaces/_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="../interfaces/_services_http_restservice_.ihttpheaders.html" class="tsd-kind-icon">IHttp<wbr>Headers</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_services_http_restservice_.imethodoptions.html" class="tsd-kind-icon">IMethod<wbr>Options</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_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="_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="_services_http_restservice_.html#restparamattr" class="tsd-kind-icon">Rest<wbr>Param<wbr>Attr</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#body" class="tsd-kind-icon">Body</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_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="_services_http_restservice_.html#delete" class="tsd-kind-icon">Delete</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#get" class="tsd-kind-icon">Get</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#header" class="tsd-kind-icon">Header</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#patch" class="tsd-kind-icon">Patch</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#path" class="tsd-kind-icon">Path</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#post" class="tsd-kind-icon">Post</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#put" class="tsd-kind-icon">Put</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#queries" class="tsd-kind-icon">Queries</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_services_http_restservice_.html#query" class="tsd-kind-icon">Query</a></li> <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_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="_services_http_restservice_.html#xmlbody" class="tsd-kind-icon">Xml<wbr>Body</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_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="_services_http_restservice_.html#cancel" class="tsd-kind-icon">Cancel</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 tsd-parent-kind-external-module"> <a name="restattr" class="tsd-anchor"></a> <h3>Rest<wbr>Attr</h3> <div class="tsd-signature tsd-kind-icon">Rest<wbr>Attr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</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#L123">src/services/http/RestService.ts:123</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><a href="../classes/_services_http_restservice_.baseservice.html" class="tsd-signature-type">BaseService</a>, propertyKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, parameterIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>target: <a href="../classes/_services_http_restservice_.baseservice.html" class="tsd-signature-type">BaseService</a></h5> </li> <li> <h5>propertyKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5> </li> <li> <h5>parameterIndex: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="restmethodattr" class="tsd-anchor"></a> <h3>Rest<wbr>Method<wbr>Attr</h3> <div class="tsd-signature tsd-kind-icon">Rest<wbr>Method<wbr>Attr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</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#L130">src/services/http/RestService.ts:130</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_services_http_restservice_.imethodoptions.html" class="tsd-signature-type">IMethodOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_services_http_restservice_.imethodoptions.html" class="tsd-signature-type">IMethodOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4> <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>target<span class="tsd-signature-symbol">: </span><a href="../classes/_services_http_restservice_.baseservice.html" class="tsd-signature-type">BaseService</a>, propertyKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>target: <a href="../classes/_services_http_restservice_.baseservice.html" class="tsd-signature-type">BaseService</a></h5> </li> <li> <h5>propertyKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5> </li> <li> <h5>descriptor: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="restparamattr" class="tsd-anchor"></a> <h3>Rest<wbr>Param<wbr>Attr</h3> <div class="tsd-signature tsd-kind-icon">Rest<wbr>Param<wbr>Attr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</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#L127">src/services/http/RestService.ts:127</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, defaultValue<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><a href="_services_http_restservice_.html#restattr" class="tsd-signature-type">RestAttr</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> defaultValue: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_services_http_restservice_.html#restattr" class="tsd-signature-type">RestAttr</a></h4> </li> </ul> </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-parent-kind-external-module"> <a name="body" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Body</h3> <div class="tsd-signature tsd-kind-icon">Body<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restattr" class="tsd-signature-type">RestAttr</a><span class="tsd-signature-symbol"> = parameterBuilder("Body")("")</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#L214">src/services/http/RestService.ts:214</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This will register data fragment on ajax.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Post</span>(<span class="hljs-string">"/api/products"</span>) async getProducts( <span class="hljs-variable">@Query</span>(<span class="hljs-string">"id"</span>) <span class="hljs-attribute">id</span>: number, <span class="hljs-variable">@Body</span> <span class="hljs-attribute">product</span>: Product ): Promise<Product[]> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Body</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="bodyformmodel" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Body<wbr>Form<wbr>Model</h3> <div class="tsd-signature tsd-kind-icon">Body<wbr>Form<wbr>Model<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restattr" class="tsd-signature-type">RestAttr</a><span class="tsd-signature-symbol"> = parameterBuilder("BodyFormModel")("")</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#L233">src/services/http/RestService.ts:233</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This will register data fragment on ajax in old formModel way.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Post</span>(<span class="hljs-string">"/api/products"</span>) async getProducts( <span class="hljs-variable">@Query</span>(<span class="hljs-string">"id"</span>) <span class="hljs-attribute">id</span>: number, <span class="hljs-variable">@BodyFormModel</span> <span class="hljs-attribute">product</span>: Product ): Promise<Product[]> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>BodyFormModel</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="delete" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Delete</h3> <div class="tsd-signature tsd-kind-icon">Delete<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restmethodattr" class="tsd-signature-type">RestMethodAttr</a><span class="tsd-signature-symbol"> = methodBuilder("Delete")</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#L283">src/services/http/RestService.ts:283</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Http Delete method</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Delete</span>(<span class="hljs-string">"/api/products"</span>) async deleteProduct( <span class="hljs-variable">@Body</span> <span class="hljs-attribute">product</span>: Product ): Promise<Product> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Delete</p> </dd> <dt>param</dt> <dd><p>Url for the operation</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="get" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Get</h3> <div class="tsd-signature tsd-kind-icon">Get<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restmethodattr" class="tsd-signature-type">RestMethodAttr</a><span class="tsd-signature-symbol"> = methodBuilder("Get")</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#L267">src/services/http/RestService.ts:267</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Http Get Method</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Get</span>(<span class="hljs-string">"/api/products/{category}"</span>) async getProducts( <span class="hljs-variable">@Path</span>(<span class="hljs-string">"category"</span>) category?:string ): Promise<Product[]> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Body</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="header" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Header</h3> <div class="tsd-signature tsd-kind-icon">Header<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restparamattr" class="tsd-signature-type">RestParamAttr</a><span class="tsd-signature-symbol"> = parameterBuilder("Header")</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#L166">src/services/http/RestService.ts:166</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This will register header on parameter.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Get</span>(<span class="hljs-string">"/api/products/{category}"</span>) async getProducts( <span class="hljs-variable">@Header</span>(<span class="hljs-string">"x-http-auth"</span>) <span class="hljs-attribute">category</span>: number ): Promise<Product[]> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Path</p> </dd> <dt>param</dt> <dd><p>Name of the parameter</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="patch" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Patch</h3> <div class="tsd-signature tsd-kind-icon">Patch<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restmethodattr" class="tsd-signature-type">RestMethodAttr</a><span class="tsd-signature-symbol"> = methodBuilder("Patch")</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#L315">src/services/http/RestService.ts:315</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Http Patch method</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Patch</span>(<span class="hljs-string">"/api/products"</span>) async saveProduct( <span class="hljs-variable">@Body</span> <span class="hljs-attribute">product</span>: any ): Promise<Product> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Patch</p> </dd> <dt>param</dt> <dd><p>Url for the operation</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="path" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Path</h3> <div class="tsd-signature tsd-kind-icon">Path<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restparamattr" class="tsd-signature-type">RestParamAttr</a><span class="tsd-signature-symbol"> = parameterBuilder("Path")</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#L149">src/services/http/RestService.ts:149</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This will register Url path fragment on parameter.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Get</span>(<span class="hljs-string">"/api/products/{category}"</span>) async getProducts( <span class="hljs-variable">@Path</span>(<span class="hljs-string">"category"</span>) <span class="hljs-attribute">category</span>: number ): Promise<Product[]> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Path</p> </dd> <dt>param</dt> <dd><p>Name of the parameter</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="post" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Post</h3> <div class="tsd-signature tsd-kind-icon">Post<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restmethodattr" class="tsd-signature-type">RestMethodAttr</a><span class="tsd-signature-symbol"> = methodBuilder("Post")</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#L251">src/services/http/RestService.ts:251</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Http Post method</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Post</span>(<span class="hljs-string">"/api/products"</span>) async saveProduct( <span class="hljs-variable">@Body</span> <span class="hljs-attribute">product</span>: Product ): Promise<Product> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Post</p> </dd> <dt>param</dt> <dd><p>Url for the operation</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="put" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Put</h3> <div class="tsd-signature tsd-kind-icon">Put<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restmethodattr" class="tsd-signature-type">RestMethodAttr</a><span class="tsd-signature-symbol"> = methodBuilder("Put")</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#L299">src/services/http/RestService.ts:299</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Http Put method</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Put</span>(<span class="hljs-string">"/api/products"</span>) async saveProduct( <span class="hljs-variable">@Body</span> <span class="hljs-attribute">product</span>: Product ): Promise<Product> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Put</p> </dd> <dt>param</dt> <dd><p>Url for the operation</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="queries" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Queries</h3> <div class="tsd-signature tsd-kind-icon">Queries<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restattr" class="tsd-signature-type">RestAttr</a><span class="tsd-signature-symbol"> = parameterBuilder("Queries")("")</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#L197">src/services/http/RestService.ts:197</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This will register Url query fragments on parameter of type object</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-variable">@Get</span>(<span class="hljs-string">"/api/products"</span>) async getProducts( <span class="hljs-variable">@Queries</span> <span class="hljs-attribute">queries</span>: { [<span class="hljs-attribute">key</span>: string]: string | number | boolean | null } ): Promise<Product[]> { <span class="hljs-selector-tag">return</span> <span class="hljs-selector-tag">null</span>;</code></pre><p>}</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="query" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Query</h3> <div class="tsd-signature tsd-kind-icon">Query<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restparamattr" class="tsd-signature-type">RestParamAttr</a><span class="tsd-signature-symbol"> = parameterBuilder("Query")</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#L183">src/services/http/RestService.ts:183</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This will register Url query fragment on parameter.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Get</span>(<span class="hljs-string">"/api/products"</span>) async getProducts( <span class="hljs-variable">@Query</span>(<span class="hljs-string">"category"</span>) <span class="hljs-attribute">category</span>: number ): Promise<Product[]> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Query</p> </dd> <dt>param</dt> <dd><p>Name of the parameter</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="rawbody" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Raw<wbr>Body</h3> <div class="tsd-signature tsd-kind-icon">Raw<wbr>Body<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restattr" class="tsd-signature-type">RestAttr</a><span class="tsd-signature-symbol"> = parameterBuilder("RawBody")("")</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#L216">src/services/http/RestService.ts:216</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module"> <a name="xmlbody" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Xml<wbr>Body</h3> <div class="tsd-signature tsd-kind-icon">Xml<wbr>Body<span class="tsd-signature-symbol">:</span> <a href="_services_http_restservice_.html#restattr" class="tsd-signature-type">RestAttr</a><span class="tsd-signature-symbol"> = parameterBuilder("XmlBody")("")</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#L235">src/services/http/RestService.ts:235</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 tsd-parent-kind-external-module"> <a name="baseurl" class="tsd-anchor"></a> <h3>Base<wbr>Url</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">Base<wbr>Url<span class="tsd-signature-symbol">(</span>baseUrl<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">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/web-atoms/core/blob/8e9453e/src/services/http/RestService.ts#L356">src/services/http/RestService.ts:356</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>baseUrl: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4> <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>target<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>target: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="cancel" class="tsd-anchor"></a> <h3>Cancel</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">Cancel<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><a href="../classes/_services_http_restservice_.baseservice.html" class="tsd-signature-type">BaseService</a>, propertyKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, parameterIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/http/RestService.ts#L332">src/services/http/RestService.ts:332</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Cancellation token</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code> <span class="hljs-variable">@Put</span>(<span class="hljs-string">"/api/products"</span>) async saveProduct( <span class="hljs-variable">@Body</span> <span class="hljs-attribute">product</span>: Product <span class="hljs-variable">@Cancel</span> <span class="hljs-attribute">cancel</span>: CancelToken ): Promise<Product> { }</code></pre></dd> <dt>export</dt> <dd></dd> <dt>function</dt> <dd><p>Put</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>target: <a href="../classes/_services_http_restservice_.baseservice.html" class="tsd-signature-type">BaseService</a></h5> </li> <li> <h5>propertyKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5> </li> <li> <h5>parameterIndex: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </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="_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="../interfaces/_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="../interfaces/_services_http_restservice_.ihttpheaders.html" class="tsd-kind-icon">IHttp<wbr>Headers</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_services_http_restservice_.imethodoptions.html" class="tsd-kind-icon">IMethod<wbr>Options</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_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="_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="_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="_services_http_restservice_.html#body" class="tsd-kind-icon">Body</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_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="_services_http_restservice_.html#delete" class="tsd-kind-icon">Delete</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_services_http_restservice_.html#get" class="tsd-kind-icon">Get</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_services_http_restservice_.html#header" class="tsd-kind-icon">Header</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_services_http_restservice_.html#patch" class="tsd-kind-icon">Patch</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_services_http_restservice_.html#path" class="tsd-kind-icon">Path</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_services_http_restservice_.html#post" class="tsd-kind-icon">Post</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_services_http_restservice_.html#put" class="tsd-kind-icon">Put</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_services_http_restservice_.html#queries" class="tsd-kind-icon">Queries</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_services_http_restservice_.html#query" class="tsd-kind-icon">Query</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="_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="_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="_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="_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>