lemon-core
Version:
Lemon Serverless Micro-Service Platform
282 lines (281 loc) • 41.9 kB
HTML
<html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ProtocolService | lemon-core</title><meta name="description" content="Documentation for lemon-core"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base="..">
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></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">lemon-core</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
<div class="container container-main">
<div class="col-8 col-content">
<div class="tsd-page-title">
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">lemon-core</a></li>
<li><a href="ProtocolService.html">ProtocolService</a></li></ul>
<h1>Interface ProtocolService</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>class: <code>ProtocolService</code></p>
<ul>
<li>support inter communication (sync or async) between micro-services.</li>
</ul>
</div></section>
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ProtocolService</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/ad5ebc6f/src/cores/core-services.ts#L135">src/cores/core-services.ts:135</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="ProtocolService.html#asTransformer" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>as<wbr/>Transformer</span></a>
<a href="ProtocolService.html#broadcast" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>broadcast</span></a>
<a href="ProtocolService.html#enqueue" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>enqueue</span></a>
<a href="ProtocolService.html#execute" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>execute</span></a>
<a href="ProtocolService.html#fromURL" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>fromURL</span></a>
<a href="ProtocolService.html#myProtocolURI" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>my<wbr/>ProtocolURI</span></a>
<a href="ProtocolService.html#notify" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>notify</span></a>
</div></section></div></details></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-interface"><a id="asTransformer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>as<wbr/>Transformer</span><a href="#asTransformer" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-anchor-link" id="asTransformer.asTransformer-1">as<wbr/>Transformer<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TEventParam</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TLambdaEvent</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"web"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sns"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sqs"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ProtocolTransformer.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolTransformer</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TEventParam</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TLambdaEvent</span><span class="tsd-signature-symbol">></span><a href="#asTransformer.asTransformer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>get <code>protocol-transformer</code> by name</p>
</div>
<section class="tsd-panel tsd-type-parameters">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TEventParam = <span class="tsd-signature-type">any</span></h4></li>
<li>
<h4>TLambdaEvent = <span class="tsd-signature-type" data-tsd-kind="Type parameter">TEventParam</span></h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>name: <span class="tsd-signature-type">"web"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sns"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sqs"</span></h5>
<div class="tsd-comment tsd-typography"><p>name as 'web', 'sns', 'sqs'</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="ProtocolTransformer.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolTransformer</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TEventParam</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TLambdaEvent</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/ad5ebc6f/src/cores/core-services.ts#L190">src/cores/core-services.ts:190</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="broadcast" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>broadcast</span><a href="#broadcast" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-anchor-link" id="broadcast.broadcast-1">broadcast<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="NextContext.html" class="tsd-signature-type" data-tsd-kind="Interface">NextContext</a><span class="tsd-signature-symbol"><</span><a href="NextIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">NextIdentity</a><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>, endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<span class="tsd-signature-symbol">: </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#broadcast.broadcast-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>broadcast body message via shared <code>SNS</code> subscriptions. (see <code>NotificationHandler</code>)</p>
<ul>
<li><code>.service</code> will be self url like <code>api://lemon-hello-api#1.2.3</code></li>
</ul>
<h3>Returns</h3><p>the message-id if applicable.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>context: <a href="NextContext.html" class="tsd-signature-type" data-tsd-kind="Interface">NextContext</a><span class="tsd-signature-symbol"><</span><a href="NextIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">NextIdentity</a><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></h5>
<div class="tsd-comment tsd-typography"><p>the current execute context. (<code>.identity</code> will be relayed).</p>
</div></li>
<li>
<h5>endpoint: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>the SNS endpoint like <code>lemon-hello-out</code>, or full ARN.</p>
</div></li>
<li>
<h5>body: <a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a></h5>
<div class="tsd-comment tsd-typography"><p>the message body to broadcast.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/ad5ebc6f/src/cores/core-services.ts#L184">src/cores/core-services.ts:184</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="enqueue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>enqueue</span><a href="#enqueue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-anchor-link" id="enqueue.enqueue-1">enqueue<span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="ProtocolParam.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolParam</a><span class="tsd-signature-symbol"><</span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">, </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><a href="CallbackParam.html" class="tsd-signature-type" data-tsd-kind="Interface">CallbackParam</a>, delaySeconds<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#enqueue.enqueue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>asynchronous call to target function via 'SQS' (queue).</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>param: <a href="ProtocolParam.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolParam</a><span class="tsd-signature-symbol"><</span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">, </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography"><p>the calling param</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <a href="CallbackParam.html" class="tsd-signature-type" data-tsd-kind="Interface">CallbackParam</a></h5>
<div class="tsd-comment tsd-typography"><p>the return target</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> delaySeconds: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>(from AWS doc) The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies. When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/ad5ebc6f/src/cores/core-services.ts#L173">src/cores/core-services.ts:173</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="execute" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>execute</span><a href="#execute" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-anchor-link" id="execute.execute-1">execute<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="ProtocolParam.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolParam</a><span class="tsd-signature-symbol"><</span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">, </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">></span>, config<span class="tsd-signature-symbol">?: </span><a href="CoreConfigService.html" class="tsd-signature-type" data-tsd-kind="Interface">CoreConfigService</a>, uri<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><a href="#execute.execute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>synchronized call to target function via 'Lambda'.</p>
</div>
<section class="tsd-panel tsd-type-parameters">
<h4>Type Parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4></li></ul></section>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>param: <a href="ProtocolParam.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolParam</a><span class="tsd-signature-symbol"><</span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">, </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography"><p>the calling param</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> config: <a href="CoreConfigService.html" class="tsd-signature-type" data-tsd-kind="Interface">CoreConfigService</a></h5>
<div class="tsd-comment tsd-typography"><p>(optional) custom config</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> uri: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>(optional) custom uri to provide.</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/ad5ebc6f/src/cores/core-services.ts#L156">src/cores/core-services.ts:156</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="fromURL" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>fromURL</span><a href="#fromURL" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-anchor-link" id="fromURL.fromURL-1">fromURL<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="NextContext.html" class="tsd-signature-type" data-tsd-kind="Interface">NextContext</a><span class="tsd-signature-symbol"><</span><a href="NextIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">NextIdentity</a><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>, url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, param<span class="tsd-signature-symbol">?: </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a>, body<span class="tsd-signature-symbol">?: </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ProtocolParam.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolParam</a><span class="tsd-signature-symbol"><</span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">, </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">></span><a href="#fromURL.fromURL-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>from string url, transform to protocol-param.
<em>mode</em> is dependent on body condition.</p>
<ul>
<li>if body is undefined, then mode will be 'GET'</li>
<li>if body is not undefined, then mode will be 'POST'.</li>
</ul>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>context: <a href="NextContext.html" class="tsd-signature-type" data-tsd-kind="Interface">NextContext</a><span class="tsd-signature-symbol"><</span><a href="NextIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">NextIdentity</a><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></h5>
<div class="tsd-comment tsd-typography"><p>the current execute context via controller.</p>
</div></li>
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>url string must start with 'lemon://' like <code>lemon://lemon-hello-api/hello/0</code></p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> param: <a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a></h5>
<div class="tsd-comment tsd-typography"><p>query parameter (optional)</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> body: <a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a></h5>
<div class="tsd-comment tsd-typography"><p>post body (optional)</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="ProtocolParam.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolParam</a><span class="tsd-signature-symbol"><</span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">, </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/ad5ebc6f/src/cores/core-services.ts#L147">src/cores/core-services.ts:147</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="myProtocolURI" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>my<wbr/>ProtocolURI</span><a href="#myProtocolURI" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-anchor-link" id="myProtocolURI.myProtocolURI-1">my<wbr/>ProtocolURI<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="NextContext.html" class="tsd-signature-type" data-tsd-kind="Interface">NextContext</a><span class="tsd-signature-symbol"><</span><a href="NextIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">NextIdentity</a><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>, type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, cmd<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><a href="#myProtocolURI.myProtocolURI-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>get the current service's protocol uri</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>context: <a href="NextContext.html" class="tsd-signature-type" data-tsd-kind="Interface">NextContext</a><span class="tsd-signature-symbol"><</span><a href="NextIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">NextIdentity</a><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></h5>
<div class="tsd-comment tsd-typography"><p>the current context.</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> type: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>(optional) resource type</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> id: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>(optional) resource id</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> cmd: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>(optional) action command</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/ad5ebc6f/src/cores/core-services.ts#L202">src/cores/core-services.ts:202</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="notify" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>notify</span><a href="#notify" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-anchor-link" id="notify.notify-1">notify<span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="ProtocolParam.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolParam</a><span class="tsd-signature-symbol"><</span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">, </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><a href="CallbackParam.html" class="tsd-signature-type" data-tsd-kind="Interface">CallbackParam</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#notify.notify-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>asynchronous call to target function via 'SNS'.</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>param: <a href="ProtocolParam.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolParam</a><span class="tsd-signature-symbol"><</span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">, </span><a href="ProtocolBody.html" class="tsd-signature-type" data-tsd-kind="Interface">ProtocolBody</a><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography"><p>the calling param</p>
</div></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> callback: <a href="CallbackParam.html" class="tsd-signature-type" data-tsd-kind="Interface">CallbackParam</a></h5>
<div class="tsd-comment tsd-typography"><p>the return target</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/ad5ebc6f/src/cores/core-services.ts#L164">src/cores/core-services.ts:164</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
<div class="tsd-accordion-details">
<div class="tsd-filter-visibility">
<h4 class="uppercase">Member Visibility</h4><form>
<ul id="tsd-filter-options">
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
<nav class="tsd-navigation primary">
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
<div class="tsd-accordion-details">
<ul>
<li><a href="../modules.html">lemon-<wbr/>core</a>
<ul>
<li class="tsd-kind-namespace"><a href="../modules/_sns.html">$sns</a></li>
<li class="tsd-kind-namespace"><a href="../modules/_sqs.html">$sqs</a></li>
<li class="tsd-kind-namespace"><a href="../modules/_web.html">$web</a></li>
<li class="tsd-kind-namespace"><a href="../modules/_wss.html">$wss</a></li>
<li class="tsd-kind-namespace"><a href="../modules/lib.html">lib</a></li>
<li class="tsd-kind-namespace"><a href="../modules/tools.html">tools</a></li></ul></li>
<li class="tsd-kind-namespace tsd-is-external"><a href="../modules/elasticsearch.html">elasticsearch</a>
<ul>
<li class="tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/elasticsearch.RequestParams.html">Request<wbr/>Params</a></li>
<li class="tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/elasticsearch.errors.html">errors</a></li></ul></li></ul></div></details></nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul>
<li class="current tsd-kind-interface"><a href="ProtocolService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Protocol<wbr/>Service</span></a>
<ul>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="ProtocolService.html#asTransformer" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>as<wbr/>Transformer</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="ProtocolService.html#broadcast" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>broadcast</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="ProtocolService.html#enqueue" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>enqueue</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="ProtocolService.html#execute" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>execute</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="ProtocolService.html#fromURL" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>fromURL</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="ProtocolService.html#myProtocolURI" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>my<wbr/>ProtocolURI</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="ProtocolService.html#notify" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>notify</a></li></ul></li></ul></nav></div></div>
<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/main.js"></script></body></html>