Skip to content

Commit 4579f5f

Browse files
kum-deepakkum-deepak
committed
API docs for develop branch
1 parent 70f7d85 commit 4579f5f

File tree

110 files changed

+35126
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+35126
-0
lines changed

‎api-docs/develop/classes/Client.html

Lines changed: 3611 additions & 0 deletions
Large diffs are not rendered by default.

‎api-docs/develop/classes/CompatClient.html

Lines changed: 3832 additions & 0 deletions
Large diffs are not rendered by default.

‎api-docs/develop/classes/RxStomp.html

Lines changed: 2027 additions & 0 deletions
Large diffs are not rendered by default.

‎api-docs/develop/classes/RxStompConfig.html

Lines changed: 1088 additions & 0 deletions
Large diffs are not rendered by default.

‎api-docs/develop/classes/RxStompRPC.html

Lines changed: 506 additions & 0 deletions
Large diffs are not rendered by default.

‎api-docs/develop/classes/RxStompRPCConfig.html

Lines changed: 290 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,290 @@
1+
<!doctype html>
2+
<html class="no-js" lang="">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="x-ua-compatible" content="ie=edge">
6+
<title>stompjs-docs documentation</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
10+
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
11+
<link rel="stylesheet" href="../styles/style.css">
12+
<link rel="stylesheet" href="../styles/postmark.css">
13+
</head>
14+
<body>
15+
16+
<div class="navbar navbar-default navbar-fixed-top visible-xs">
17+
<a href="../" class="navbar-brand">stompjs-docs documentation</a>
18+
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
19+
</div>
20+
21+
<div class="xs-menu menu" id="mobile-menu">
22+
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
23+
</div>
24+
25+
<div class="container-fluid main">
26+
<div class="row main">
27+
<div class="hidden-xs menu">
28+
<compodoc-menu mode="normal"></compodoc-menu>
29+
</div>
30+
<!-- START CONTENT -->
31+
<div class="content class">
32+
<div class="content-data">
33+
34+
35+
36+
37+
38+
39+
40+
41+
42+
43+
44+
<ol class="breadcrumb">
45+
<li>Classes</li>
46+
<li>RxStompRPCConfig</li>
47+
</ol>
48+
49+
<ul class="nav nav-tabs" role="tablist">
50+
<li class="active">
51+
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
52+
</li>
53+
<li >
54+
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
55+
</li>
56+
</ul>
57+
58+
<div class="tab-content">
59+
<div class="tab-pane fade active in" id="c-info">
60+
<p class="comment">
61+
<h3>File</h3>
62+
</p>
63+
<p class="comment">
64+
<code>consolidated/rx-stomp/src/rx-stomp-rpc-config.ts</code>
65+
</p>
66+
67+
<p class="comment">
68+
<h3>Description</h3>
69+
</p>
70+
<p class="comment">
71+
<p>RPC Config. See the guide for example.</p>
72+
73+
</p>
74+
75+
76+
77+
78+
<section>
79+
<h3 id="index">Index</h3>
80+
<table class="table table-sm table-bordered index-table">
81+
<tbody>
82+
<tr>
83+
<td class="col-md-4">
84+
<h6><b>Properties</b></h6>
85+
</td>
86+
</tr>
87+
<tr>
88+
<td class="col-md-4">
89+
<ul class="index-list">
90+
<li>
91+
<span class="modifier">Public</span>
92+
<span class="modifier">Optional</span>
93+
<a href="#replyQueueName">replyQueueName</a>
94+
</li>
95+
<li>
96+
<span class="modifier">Public</span>
97+
<span class="modifier">Optional</span>
98+
<a href="#setupReplyQueue">setupReplyQueue</a>
99+
</li>
100+
</ul>
101+
</td>
102+
</tr>
103+
104+
105+
106+
107+
108+
109+
</tbody>
110+
</table>
111+
</section>
112+
113+
114+
<section>
115+
116+
<h3 id="inputs">
117+
Properties
118+
</h3>
119+
<table class="table table-sm table-bordered">
120+
<tbody>
121+
<tr>
122+
<td class="col-md-4">
123+
<a name="replyQueueName"></a>
124+
<span class="name">
125+
<b>
126+
<span class="modifier">Public</span>
127+
<span class="modifier">Optional</span>
128+
replyQueueName</b>
129+
<a href="#replyQueueName"><span class="icon ion-ios-link"></span></a>
130+
</span>
131+
</td>
132+
</tr>
133+
<tr>
134+
<td class="col-md-4">
135+
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
136+
137+
</td>
138+
</tr>
139+
<tr>
140+
<td class="col-md-4">
141+
<div class="io-line">Defined in <a href="" data-line="23" class="link-to-prism">consolidated/rx-stomp/src/rx-stomp-rpc-config.ts:23</a></div>
142+
</td>
143+
</tr>
144+
145+
<tr>
146+
<td class="col-md-4">
147+
<div class="io-description"><p>Name of the reply queue. See the guide for details.
148+
Default <code>/temp-queue/rpc-replies</code> suitable for RabbitMQ and ActiveMQ.</p>
149+
</div>
150+
</td>
151+
</tr>
152+
153+
</tbody>
154+
</table>
155+
<table class="table table-sm table-bordered">
156+
<tbody>
157+
<tr>
158+
<td class="col-md-4">
159+
<a name="setupReplyQueue"></a>
160+
<span class="name">
161+
<b>
162+
<span class="modifier">Public</span>
163+
<span class="modifier">Optional</span>
164+
setupReplyQueue</b>
165+
<a href="#setupReplyQueue"><span class="icon ion-ios-link"></span></a>
166+
</span>
167+
</td>
168+
</tr>
169+
<tr>
170+
<td class="col-md-4">
171+
<i>Type : </i> <code><a href="../miscellaneous/typealiases.html#setupReplyQueueFnType" target="_self" >setupReplyQueueFnType</a></code>
172+
173+
</td>
174+
</tr>
175+
<tr>
176+
<td class="col-md-4">
177+
<div class="io-line">Defined in <a href="" data-line="27" class="link-to-prism">consolidated/rx-stomp/src/rx-stomp-rpc-config.ts:27</a></div>
178+
</td>
179+
</tr>
180+
181+
<tr>
182+
<td class="col-md-4">
183+
<div class="io-description"><p>Setup the reply queue. See the guide for details.</p>
184+
</div>
185+
</td>
186+
</tr>
187+
188+
</tbody>
189+
</table>
190+
</section>
191+
192+
193+
194+
195+
196+
197+
198+
</div>
199+
200+
201+
<div class="tab-pane fade tab-source-code" id="c-source">
202+
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { IMessage } from &#x27;@stomp/stompjs&#x27;;
203+
import { Observable } from &#x27;rxjs&#x27;;
204+
import { RxStomp } from &#x27;./rx-stomp&#x27;;
205+
206+
/**
207+
* See the guide for example
208+
*
209+
* Part of &#x60;@stomp/rx-stomp&#x60;
210+
*/
211+
export type setupReplyQueueFnType &#x3D; (
212+
replyQueueName: string,
213+
rxStomp: RxStomp
214+
) &#x3D;&gt; Observable&lt;IMessage&gt;;
215+
216+
/**
217+
* RPC Config. See the guide for example.
218+
*/
219+
export class RxStompRPCConfig {
220+
/**
221+
* Name of the reply queue. See the guide for details.
222+
* Default &#x60;/temp-queue/rpc-replies&#x60; suitable for RabbitMQ and ActiveMQ.
223+
*/
224+
public replyQueueName?: string;
225+
/**
226+
* Setup the reply queue. See the guide for details.
227+
*/
228+
public setupReplyQueue?: setupReplyQueueFnType;
229+
}
230+
</code></pre>
231+
</div>
232+
</div>
233+
234+
235+
236+
237+
238+
239+
240+
241+
</div><div class="search-results">
242+
<div class="has-results">
243+
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
244+
<ul class="search-results-list"></ul>
245+
</div>
246+
<div class="no-results">
247+
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
248+
</div>
249+
</div>
250+
</div>
251+
<!-- END CONTENT -->
252+
</div>
253+
</div>
254+
255+
<script>
256+
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
257+
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
258+
var COMPODOC_CURRENT_PAGE_URL = 'RxStompRPCConfig.html';
259+
var MAX_SEARCH_RESULTS = 15;
260+
</script>
261+
262+
<script src="../js/libs/custom-elements.min.js"></script>
263+
<script src="../js/libs/lit-html.js"></script>
264+
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
265+
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
266+
<script src="../js/menu-wc.js" defer></script>
267+
268+
<script src="../js/libs/bootstrap-native.js"></script>
269+
270+
<script src="../js/libs/es6-shim.min.js"></script>
271+
<script src="../js/libs/EventDispatcher.js"></script>
272+
<script src="../js/libs/promise.min.js"></script>
273+
<script src="../js/libs/zepto.min.js"></script>
274+
275+
<script src="../js/compodoc.js"></script>
276+
277+
<script src="../js/tabs.js"></script>
278+
<script src="../js/menu.js"></script>
279+
<script src="../js/libs/clipboard.min.js"></script>
280+
<script src="../js/libs/prism.js"></script>
281+
<script src="../js/sourceCode.js"></script>
282+
<script src="../js/search/search.js"></script>
283+
<script src="../js/search/lunr.min.js"></script>
284+
<script src="../js/search/search-lunr.js"></script>
285+
<script src="../js/search/search_index.js"></script>
286+
<script src="../js/lazy-load-graphs.js"></script>
287+
288+
289+
</body>
290+
</html>

0 commit comments

Comments
 (0)