lemon-core 2.2.20 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/common/test-helper.js +1 -1
- package/dist/common/test-helper.js.map +1 -1
- package/dist/controllers/dummy-controller.js.map +1 -1
- package/dist/cores/api-service.js.map +1 -1
- package/dist/cores/aws/aws-sns-service.js +3 -3
- package/dist/cores/aws/aws-sns-service.js.map +1 -1
- package/dist/cores/core-types.d.ts +92 -2
- package/dist/cores/core-types.js +1 -0
- package/dist/cores/core-types.js.map +1 -1
- package/dist/cores/dynamo-service.js +2 -2
- package/dist/cores/dynamo-service.js.map +1 -1
- package/dist/cores/elastic6-query-service.d.ts +42 -9
- package/dist/cores/elastic6-query-service.js +144 -134
- package/dist/cores/elastic6-query-service.js.map +1 -1
- package/dist/cores/elastic6-service.d.ts +144 -57
- package/dist/cores/elastic6-service.js +506 -322
- package/dist/cores/elastic6-service.js.map +1 -1
- package/dist/cores/lambda/lambda-cognito-handler.js.map +1 -1
- package/dist/cores/lambda/lambda-cron-handler.js.map +1 -1
- package/dist/cores/lambda/lambda-dynamo-stream-handler.js +3 -3
- package/dist/cores/lambda/lambda-dynamo-stream-handler.js.map +1 -1
- package/dist/cores/lambda/lambda-notification-handler.js.map +1 -1
- package/dist/cores/lambda/lambda-sns-handler.js.map +1 -1
- package/dist/cores/lambda/lambda-web-handler.js +2 -4
- package/dist/cores/lambda/lambda-web-handler.js.map +1 -1
- package/dist/cores/lambda/lambda-wss-handler.js.map +1 -1
- package/dist/cores/protocol/protocol-service.d.ts +1 -2
- package/dist/cores/protocol/protocol-service.js +5 -3
- package/dist/cores/protocol/protocol-service.js.map +1 -1
- package/dist/engine/builder.d.ts +1 -0
- package/dist/engine/builder.js +1 -1
- package/dist/engine/builder.js.map +1 -1
- package/dist/engine/engine.js +2 -1
- package/dist/engine/engine.js.map +1 -1
- package/dist/engine/index.d.ts +0 -1
- package/dist/engine/index.js +2 -4
- package/dist/engine/index.js.map +1 -1
- package/dist/engine/types.d.ts +0 -4
- package/dist/engine/types.js.map +1 -1
- package/dist/engine/utilities.d.ts +5 -1
- package/dist/engine/utilities.js +126 -11
- package/dist/engine/utilities.js.map +1 -1
- package/dist/tools/express.js +0 -3
- package/dist/tools/express.js.map +1 -1
- package/package.json +6 -11
- package/CHANGELOG.md +0 -61
- package/dist/docs/assets/css/main.css +0 -2321
- package/dist/docs/assets/images/icons.png +0 -0
- package/dist/docs/assets/images/icons@2x.png +0 -0
- package/dist/docs/assets/images/widgets.png +0 -0
- package/dist/docs/assets/images/widgets@2x.png +0 -0
- package/dist/docs/assets/js/main.js +0 -1
- package/dist/docs/assets/js/search.js +0 -3
- package/dist/docs/classes/abstractmanager.html +0 -1054
- package/dist/docs/classes/apiproxyclient.html +0 -509
- package/dist/docs/classes/apiservice.html +0 -805
- package/dist/docs/classes/awskmsservice.html +0 -468
- package/dist/docs/classes/awsmodule.html +0 -353
- package/dist/docs/classes/awss3service.html +0 -563
- package/dist/docs/classes/awssnsservice.html +0 -543
- package/dist/docs/classes/awssqsservice.html +0 -517
- package/dist/docs/classes/cacheservice.html +0 -996
- package/dist/docs/classes/configmodule.html +0 -311
- package/dist/docs/classes/dummycacheservice.html +0 -1000
- package/dist/docs/classes/dummycontroller.html +0 -709
- package/dist/docs/classes/dummydynamoservice.html +0 -915
- package/dist/docs/classes/dummyelastic6service.html +0 -791
- package/dist/docs/classes/dummyredisstorageservice.html +0 -804
- package/dist/docs/classes/dummystoragemaker.html +0 -383
- package/dist/docs/classes/dummystorageservice.html +0 -592
- package/dist/docs/classes/dynamoqueryservice.html +0 -413
- package/dist/docs/classes/dynamoscanservice.html +0 -358
- package/dist/docs/classes/dynamoservice.html +0 -844
- package/dist/docs/classes/dynamostorageservice.html +0 -623
- package/dist/docs/classes/elastic6queryservice.html +0 -458
- package/dist/docs/classes/elastic6service.html +0 -804
- package/dist/docs/classes/generalapicontroller.html +0 -877
- package/dist/docs/classes/generalcontroller.html +0 -454
- package/dist/docs/classes/generalcontrollerlocal.html +0 -499
- package/dist/docs/classes/generalcontrollerlocal2.html +0 -523
- package/dist/docs/classes/generalkeymaker.html +0 -335
- package/dist/docs/classes/generalmodelfilter.html +0 -529
- package/dist/docs/classes/generalwebcontroller.html +0 -580
- package/dist/docs/classes/hangulservice.html +0 -636
- package/dist/docs/classes/httpstorageservice.html +0 -539
- package/dist/docs/classes/lambdacognitohandler.html +0 -355
- package/dist/docs/classes/lambdacronhandler.html +0 -390
- package/dist/docs/classes/lambdacronhandlerlocal.html +0 -371
- package/dist/docs/classes/lambdadynamostreamhandler.html +0 -472
- package/dist/docs/classes/lambdadynamostreamhandlerlocal.html +0 -455
- package/dist/docs/classes/lambdahandler.html +0 -479
- package/dist/docs/classes/lambdahandlerlocal.html +0 -472
- package/dist/docs/classes/lambdamodule.html +0 -433
- package/dist/docs/classes/lambdanotificationhandler.html +0 -474
- package/dist/docs/classes/lambdanotificationhandlerlocal.html +0 -457
- package/dist/docs/classes/lambdasnshandler.html +0 -394
- package/dist/docs/classes/lambdasnshandlerlocal.html +0 -397
- package/dist/docs/classes/lambdasqshandler.html +0 -394
- package/dist/docs/classes/lambdasqshandlerlocal.html +0 -397
- package/dist/docs/classes/lambdasubhandler.html +0 -305
- package/dist/docs/classes/lambdawebhandler.html +0 -603
- package/dist/docs/classes/lambdawebhandlerlocal.html +0 -581
- package/dist/docs/classes/lambdawsshandler.html +0 -359
- package/dist/docs/classes/memcachedbackend.html +0 -900
- package/dist/docs/classes/mocksapiservice.html +0 -691
- package/dist/docs/classes/modelutil.html +0 -311
- package/dist/docs/classes/myconfigservice.html +0 -561
- package/dist/docs/classes/myconfigservicetest.html +0 -527
- package/dist/docs/classes/myconfigservicetest2.html +0 -522
- package/dist/docs/classes/mydummysqsservice.html +0 -419
- package/dist/docs/classes/myenginemodules.html +0 -357
- package/dist/docs/classes/mygeneralapicontroller.html +0 -837
- package/dist/docs/classes/mylemonwebcontroller.html +0 -356
- package/dist/docs/classes/mymodelfilter.html +0 -479
- package/dist/docs/classes/myprotocolservice.html +0 -993
- package/dist/docs/classes/myprotocolservicetest.html +0 -983
- package/dist/docs/classes/myservice.html +0 -329
- package/dist/docs/classes/mystorage.html +0 -1370
- package/dist/docs/classes/nodecachebackend.html +0 -714
- package/dist/docs/classes/protocolmodule.html +0 -311
- package/dist/docs/classes/proxystorageservice.html +0 -1441
- package/dist/docs/classes/query.html +0 -850
- package/dist/docs/classes/redisbackend.html +0 -781
- package/dist/docs/classes/redisstorageservice.html +0 -867
- package/dist/docs/classes/s3putobjectrequestbuilder.html +0 -509
- package/dist/docs/classes/scan.html +0 -685
- package/dist/docs/classes/snsprotocoltransformer.html +0 -334
- package/dist/docs/classes/sqsprotocoltransformer.html +0 -334
- package/dist/docs/classes/typedstorageservice.html +0 -914
- package/dist/docs/classes/uniquefieldmanager.html +0 -477
- package/dist/docs/classes/usermanager.html +0 -931
- package/dist/docs/classes/utilities.html +0 -1914
- package/dist/docs/classes/webprotocoltransformer.html +0 -330
- package/dist/docs/globals.html +0 -7477
- package/dist/docs/index.html +0 -1519
- package/dist/docs/interfaces/accountitem.html +0 -277
- package/dist/docs/interfaces/accountmodel.html +0 -306
- package/dist/docs/interfaces/adaptiveparam.html +0 -203
- package/dist/docs/interfaces/apiheaders.html +0 -183
- package/dist/docs/interfaces/apihttpproxy.html +0 -304
- package/dist/docs/interfaces/apiserviceclient.html +0 -448
- package/dist/docs/interfaces/autocompletesearchparam.html +0 -309
- package/dist/docs/interfaces/betweencondition.html +0 -226
- package/dist/docs/interfaces/cachebackend.html +0 -714
- package/dist/docs/interfaces/cacheentry.html +0 -248
- package/dist/docs/interfaces/cacheoptions.html +0 -267
- package/dist/docs/interfaces/callbackdata.html +0 -279
- package/dist/docs/interfaces/callbackparam.html +0 -252
- package/dist/docs/interfaces/comparisoncondition.html +0 -226
- package/dist/docs/interfaces/coreconfigservice.html +0 -342
- package/dist/docs/interfaces/corekey.html +0 -278
- package/dist/docs/interfaces/corekeymakeable.html +0 -292
- package/dist/docs/interfaces/corekmsservice.html +0 -311
- package/dist/docs/interfaces/coremodel.html +0 -499
- package/dist/docs/interfaces/coremodelfilterable.html +0 -281
- package/dist/docs/interfaces/cores3service.html +0 -444
- package/dist/docs/interfaces/coreservices.html +0 -232
- package/dist/docs/interfaces/coresnsservice.html +0 -317
- package/dist/docs/interfaces/corewebcontroller.html +0 -271
- package/dist/docs/interfaces/cronevent.html +0 -223
- package/dist/docs/interfaces/cronparam.html +0 -212
- package/dist/docs/interfaces/dynamooption.html +0 -254
- package/dist/docs/interfaces/dynamoqueryresult.html +0 -244
- package/dist/docs/interfaces/dynamoscanresult.html +0 -244
- package/dist/docs/interfaces/dynamosimplequeriable.html +0 -308
- package/dist/docs/interfaces/dynamosimplescannable.html +0 -255
- package/dist/docs/interfaces/dynamostreambody.html +0 -268
- package/dist/docs/interfaces/dynamostreamcallback.html +0 -209
- package/dist/docs/interfaces/dynamostreamfilter.html +0 -218
- package/dist/docs/interfaces/dynamostreamparam.html +0 -240
- package/dist/docs/interfaces/elastic6item.html +0 -221
- package/dist/docs/interfaces/elastic6option.html +0 -275
- package/dist/docs/interfaces/elastic6simplequeriable.html +0 -284
- package/dist/docs/interfaces/engineconsole.html +0 -292
- package/dist/docs/interfaces/enginecore.html +0 -344
- package/dist/docs/interfaces/enginemodule.html +0 -269
- package/dist/docs/interfaces/enginemodules.html +0 -316
- package/dist/docs/interfaces/engineoption.html +0 -244
- package/dist/docs/interfaces/enginescope.html +0 -220
- package/dist/docs/interfaces/existencecondition.html +0 -212
- package/dist/docs/interfaces/filter.html +0 -253
- package/dist/docs/interfaces/generalfuntion.html +0 -207
- package/dist/docs/interfaces/generalitem.html +0 -212
- package/dist/docs/interfaces/handlermap.html +0 -171
- package/dist/docs/interfaces/incrementable.html +0 -190
- package/dist/docs/interfaces/internalkey.html +0 -210
- package/dist/docs/interfaces/internalmodel.html +0 -226
- package/dist/docs/interfaces/itementry.html +0 -241
- package/dist/docs/interfaces/jwtcommon.html +0 -242
- package/dist/docs/interfaces/lambdahandlerservice.html +0 -340
- package/dist/docs/interfaces/lemonengine.html +0 -593
- package/dist/docs/interfaces/metricpostbody.html +0 -220
- package/dist/docs/interfaces/mygeneral.html +0 -271
- package/dist/docs/interfaces/mymodel.html +0 -554
- package/dist/docs/interfaces/myprotocolparam.html +0 -359
- package/dist/docs/interfaces/nextcontext.html +0 -381
- package/dist/docs/interfaces/nextidentity.html +0 -325
- package/dist/docs/interfaces/nextidentityaccess.html +0 -495
- package/dist/docs/interfaces/nextidentitycognito.html +0 -422
- package/dist/docs/interfaces/notificationbody.html +0 -171
- package/dist/docs/interfaces/notificationparam.html +0 -304
- package/dist/docs/interfaces/options.html +0 -226
- package/dist/docs/interfaces/parrallelcallback.html +0 -203
- package/dist/docs/interfaces/parrallelparam.html +0 -285
- package/dist/docs/interfaces/protocolbody.html +0 -183
- package/dist/docs/interfaces/protocolparam.html +0 -336
- package/dist/docs/interfaces/protocolservice.html +0 -548
- package/dist/docs/interfaces/protocoltransformer.html +0 -295
- package/dist/docs/interfaces/proxyparams.html +0 -212
- package/dist/docs/interfaces/putobjectresult.html +0 -282
- package/dist/docs/interfaces/queryresult.html +0 -272
- package/dist/docs/interfaces/redisoptions.html +0 -248
- package/dist/docs/interfaces/simplesearchparam.html +0 -351
- package/dist/docs/interfaces/slackaction.html +0 -240
- package/dist/docs/interfaces/slackattachment.html +0 -459
- package/dist/docs/interfaces/slackpostbody.html +0 -240
- package/dist/docs/interfaces/sqsattribute.html +0 -171
- package/dist/docs/interfaces/sqsmessage.html +0 -254
- package/dist/docs/interfaces/sqsrecord.html +0 -324
- package/dist/docs/interfaces/sqsservice.html +0 -333
- package/dist/docs/interfaces/sqsstatistics.html +0 -240
- package/dist/docs/interfaces/storagemakeable.html +0 -258
- package/dist/docs/interfaces/storagemodel.html +0 -285
- package/dist/docs/interfaces/storageservice.html +0 -497
- package/dist/docs/interfaces/stringcondition.html +0 -226
- package/dist/docs/interfaces/tagset.html +0 -171
- package/dist/docs/interfaces/testmodel.html +0 -334
- package/dist/docs/interfaces/timeout.html +0 -233
- package/dist/docs/interfaces/updatable.html +0 -193
- package/dist/docs/interfaces/user.html +0 -534
|
@@ -1,805 +0,0 @@
|
|
|
1
|
-
<!doctype html>
|
|
2
|
-
<html class="default no-js">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
-
<title>APIService | lemon-core - v2.2.20</title>
|
|
7
|
-
<meta name="description" content="">
|
|
8
|
-
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
-
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
-
</head>
|
|
11
|
-
<body>
|
|
12
|
-
<header>
|
|
13
|
-
<div class="tsd-page-toolbar">
|
|
14
|
-
<div class="container">
|
|
15
|
-
<div class="table-wrap">
|
|
16
|
-
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
|
17
|
-
<div class="field">
|
|
18
|
-
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
19
|
-
<input id="tsd-search-field" type="text" />
|
|
20
|
-
</div>
|
|
21
|
-
<ul class="results">
|
|
22
|
-
<li class="state loading">Preparing search index...</li>
|
|
23
|
-
<li class="state failure">The search index is not available</li>
|
|
24
|
-
</ul>
|
|
25
|
-
<a href="../index.html" class="title">lemon-core - v2.2.20</a>
|
|
26
|
-
</div>
|
|
27
|
-
<div class="table-cell" id="tsd-widgets">
|
|
28
|
-
<div id="tsd-filter">
|
|
29
|
-
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
30
|
-
<div class="tsd-filter-group">
|
|
31
|
-
<div class="tsd-select" id="tsd-filter-visibility">
|
|
32
|
-
<span class="tsd-select-label">All</span>
|
|
33
|
-
<ul class="tsd-select-list">
|
|
34
|
-
<li data-value="public">Public</li>
|
|
35
|
-
<li data-value="protected">Public/Protected</li>
|
|
36
|
-
<li data-value="private" class="selected">All</li>
|
|
37
|
-
</ul>
|
|
38
|
-
</div>
|
|
39
|
-
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
40
|
-
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
41
|
-
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
42
|
-
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
43
|
-
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
44
|
-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
|
45
|
-
</div>
|
|
46
|
-
</div>
|
|
47
|
-
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
48
|
-
</div>
|
|
49
|
-
</div>
|
|
50
|
-
</div>
|
|
51
|
-
</div>
|
|
52
|
-
<div class="tsd-page-title">
|
|
53
|
-
<div class="container">
|
|
54
|
-
<ul class="tsd-breadcrumb">
|
|
55
|
-
<li>
|
|
56
|
-
<a href="../globals.html">Globals</a>
|
|
57
|
-
</li>
|
|
58
|
-
<li>
|
|
59
|
-
<a href="apiservice.html">APIService</a>
|
|
60
|
-
</li>
|
|
61
|
-
</ul>
|
|
62
|
-
<h1>Class APIService</h1>
|
|
63
|
-
</div>
|
|
64
|
-
</div>
|
|
65
|
-
</header>
|
|
66
|
-
<div class="container container-main">
|
|
67
|
-
<div class="row">
|
|
68
|
-
<div class="col-8 col-content">
|
|
69
|
-
<section class="tsd-panel tsd-comment">
|
|
70
|
-
<div class="tsd-comment tsd-typography">
|
|
71
|
-
<div class="lead">
|
|
72
|
-
<p>class: <code>APIService</code></p>
|
|
73
|
-
<ul>
|
|
74
|
-
<li>use internal http-proxy service due to restriction internet-face in VPC lambda.</li>
|
|
75
|
-
</ul>
|
|
76
|
-
</div>
|
|
77
|
-
</div>
|
|
78
|
-
</section>
|
|
79
|
-
<section class="tsd-panel tsd-hierarchy">
|
|
80
|
-
<h3>Hierarchy</h3>
|
|
81
|
-
<ul class="tsd-hierarchy">
|
|
82
|
-
<li>
|
|
83
|
-
<span class="target">APIService</span>
|
|
84
|
-
</li>
|
|
85
|
-
</ul>
|
|
86
|
-
</section>
|
|
87
|
-
<section class="tsd-panel">
|
|
88
|
-
<h3>Implements</h3>
|
|
89
|
-
<ul class="tsd-hierarchy">
|
|
90
|
-
<li><a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></li>
|
|
91
|
-
</ul>
|
|
92
|
-
</section>
|
|
93
|
-
<section class="tsd-panel-group tsd-index-group">
|
|
94
|
-
<h2>Index</h2>
|
|
95
|
-
<section class="tsd-panel tsd-index-panel">
|
|
96
|
-
<div class="tsd-index-content">
|
|
97
|
-
<section class="tsd-index-section ">
|
|
98
|
-
<h3>Constructors</h3>
|
|
99
|
-
<ul class="tsd-index-list">
|
|
100
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="apiservice.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
101
|
-
</ul>
|
|
102
|
-
</section>
|
|
103
|
-
<section class="tsd-index-section ">
|
|
104
|
-
<h3>Properties</h3>
|
|
105
|
-
<ul class="tsd-index-list">
|
|
106
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="apiservice.html#client" class="tsd-kind-icon">client</a></li>
|
|
107
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="apiservice.html#endpoint" class="tsd-kind-icon">endpoint</a></li>
|
|
108
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="apiservice.html#headers" class="tsd-kind-icon">headers</a></li>
|
|
109
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="apiservice.html#type" class="tsd-kind-icon">type</a></li>
|
|
110
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="apiservice.html#apiserviceclientrecorder" class="tsd-kind-icon">APIService<wbr>Client<wbr>Recorder</a></li>
|
|
111
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="apiservice.html#apihttpproxyrecorder" class="tsd-kind-icon">Api<wbr>Http<wbr>Proxy<wbr>Recorder</a></li>
|
|
112
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="apiservice.html#proxyserviceclient" class="tsd-kind-icon">Proxy<wbr>Service<wbr>Client</a></li>
|
|
113
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="apiservice.html#subtypeclient" class="tsd-kind-icon">Sub<wbr>Type<wbr>Client</a></li>
|
|
114
|
-
</ul>
|
|
115
|
-
</section>
|
|
116
|
-
<section class="tsd-index-section ">
|
|
117
|
-
<h3>Methods</h3>
|
|
118
|
-
<ul class="tsd-index-list">
|
|
119
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="apiservice.html#buildrecorder" class="tsd-kind-icon">build<wbr>Recorder</a></li>
|
|
120
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="apiservice.html#buildsubtypeclient" class="tsd-kind-icon">build<wbr>Sub<wbr>Type<wbr>Client</a></li>
|
|
121
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="apiservice.html#dodelete" class="tsd-kind-icon">do<wbr>Delete</a></li>
|
|
122
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="apiservice.html#doget" class="tsd-kind-icon">do<wbr>Get</a></li>
|
|
123
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="apiservice.html#dopatch" class="tsd-kind-icon">do<wbr>Patch</a></li>
|
|
124
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="apiservice.html#dopost" class="tsd-kind-icon">do<wbr>Post</a></li>
|
|
125
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="apiservice.html#doput" class="tsd-kind-icon">do<wbr>Put</a></li>
|
|
126
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="apiservice.html#hello" class="tsd-kind-icon">hello</a></li>
|
|
127
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="apiservice.html#buildclient" class="tsd-kind-icon">build<wbr>Client</a></li>
|
|
128
|
-
</ul>
|
|
129
|
-
</section>
|
|
130
|
-
</div>
|
|
131
|
-
</section>
|
|
132
|
-
</section>
|
|
133
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
134
|
-
<h2>Constructors</h2>
|
|
135
|
-
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
136
|
-
<a name="constructor" class="tsd-anchor"></a>
|
|
137
|
-
<h3>constructor</h3>
|
|
138
|
-
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
139
|
-
<li class="tsd-signature tsd-kind-icon">new APIService<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, headers<span class="tsd-signature-symbol">?: </span><a href="../interfaces/apiheaders.html" class="tsd-signature-type">APIHeaders</a>, client<span class="tsd-signature-symbol">?: </span><a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a>, proxy<span class="tsd-signature-symbol">?: </span><a href="../interfaces/apihttpproxy.html" class="tsd-signature-type">ApiHttpProxy</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="apiservice.html" class="tsd-signature-type">APIService</a></li>
|
|
140
|
-
</ul>
|
|
141
|
-
<ul class="tsd-descriptions">
|
|
142
|
-
<li class="tsd-description">
|
|
143
|
-
<aside class="tsd-sources">
|
|
144
|
-
<ul>
|
|
145
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L114">src/cores/api-service.ts:114</a></li>
|
|
146
|
-
</ul>
|
|
147
|
-
</aside>
|
|
148
|
-
<div class="tsd-comment tsd-typography">
|
|
149
|
-
<div class="lead">
|
|
150
|
-
<p>create API service.</p>
|
|
151
|
-
</div>
|
|
152
|
-
<pre><code class="language-js"><span class="hljs-comment">// basic</span>
|
|
153
|
-
<span class="hljs-keyword">const</span> api = <span class="hljs-keyword">new</span> API(<span class="hljs-string">'web'</span>, <span class="hljs-string">'http://localhost:8081'</span>, {});
|
|
154
|
-
api.doGet(<span class="hljs-string">''</span>);
|
|
155
|
-
|
|
156
|
-
<span class="hljs-comment">// via python</span>
|
|
157
|
-
<span class="hljs-keyword">const</span> api = <span class="hljs-keyword">new</span> API(<span class="hljs-string">'residents'</span>, <span class="hljs-string">'http://localhost:8113'</span>, {});
|
|
158
|
-
api.doGet(<span class="hljs-string">'123'</span>); <span class="hljs-comment">// http GET :8113/residents/123</span>
|
|
159
|
-
|
|
160
|
-
<span class="hljs-comment">// proxy server</span>
|
|
161
|
-
<span class="hljs-keyword">const</span> api = <span class="hljs-keyword">new</span> API(<span class="hljs-string">'web'</span>, <span class="hljs-string">'http://localhost:8081'</span>, {}, <span class="hljs-literal">null</span>, proxy);
|
|
162
|
-
api.doGet(<span class="hljs-string">''</span>);</code></pre>
|
|
163
|
-
</div>
|
|
164
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
165
|
-
<ul class="tsd-parameters">
|
|
166
|
-
<li>
|
|
167
|
-
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
168
|
-
<div class="tsd-comment tsd-typography">
|
|
169
|
-
<div class="lead">
|
|
170
|
-
<p>type in endpoint</p>
|
|
171
|
-
</div>
|
|
172
|
-
</div>
|
|
173
|
-
</li>
|
|
174
|
-
<li>
|
|
175
|
-
<h5>endpoint: <span class="tsd-signature-type">string</span></h5>
|
|
176
|
-
<div class="tsd-comment tsd-typography">
|
|
177
|
-
<div class="lead">
|
|
178
|
-
<p>base endpoint (support ONLY http, https)</p>
|
|
179
|
-
</div>
|
|
180
|
-
</div>
|
|
181
|
-
</li>
|
|
182
|
-
<li>
|
|
183
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> headers: <a href="../interfaces/apiheaders.html" class="tsd-signature-type">APIHeaders</a></h5>
|
|
184
|
-
<div class="tsd-comment tsd-typography">
|
|
185
|
-
<div class="lead">
|
|
186
|
-
<p>common headers.</p>
|
|
187
|
-
</div>
|
|
188
|
-
</div>
|
|
189
|
-
</li>
|
|
190
|
-
<li>
|
|
191
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> client: <a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></h5>
|
|
192
|
-
<div class="tsd-comment tsd-typography">
|
|
193
|
-
<div class="lead">
|
|
194
|
-
<p>real api-client to use (or use proxy, or create default)</p>
|
|
195
|
-
</div>
|
|
196
|
-
</div>
|
|
197
|
-
</li>
|
|
198
|
-
<li>
|
|
199
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> proxy: <a href="../interfaces/apihttpproxy.html" class="tsd-signature-type">ApiHttpProxy</a></h5>
|
|
200
|
-
<div class="tsd-comment tsd-typography">
|
|
201
|
-
<div class="lead">
|
|
202
|
-
<p>proxy-service to use if there is no client (or use backbone server)</p>
|
|
203
|
-
</div>
|
|
204
|
-
</div>
|
|
205
|
-
</li>
|
|
206
|
-
</ul>
|
|
207
|
-
<h4 class="tsd-returns-title">Returns <a href="apiservice.html" class="tsd-signature-type">APIService</a></h4>
|
|
208
|
-
</li>
|
|
209
|
-
</ul>
|
|
210
|
-
</section>
|
|
211
|
-
</section>
|
|
212
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
213
|
-
<h2>Properties</h2>
|
|
214
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
215
|
-
<a name="client" class="tsd-anchor"></a>
|
|
216
|
-
<h3><span class="tsd-flag ts-flagProtected">Protected</span> client</h3>
|
|
217
|
-
<div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></div>
|
|
218
|
-
<aside class="tsd-sources">
|
|
219
|
-
<ul>
|
|
220
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L114">src/cores/api-service.ts:114</a></li>
|
|
221
|
-
</ul>
|
|
222
|
-
</aside>
|
|
223
|
-
</section>
|
|
224
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
225
|
-
<a name="endpoint" class="tsd-anchor"></a>
|
|
226
|
-
<h3><span class="tsd-flag ts-flagProtected">Protected</span> endpoint</h3>
|
|
227
|
-
<div class="tsd-signature tsd-kind-icon">endpoint<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
228
|
-
<aside class="tsd-sources">
|
|
229
|
-
<ul>
|
|
230
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L112">src/cores/api-service.ts:112</a></li>
|
|
231
|
-
</ul>
|
|
232
|
-
</aside>
|
|
233
|
-
</section>
|
|
234
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
235
|
-
<a name="headers" class="tsd-anchor"></a>
|
|
236
|
-
<h3><span class="tsd-flag ts-flagProtected">Protected</span> headers</h3>
|
|
237
|
-
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <a href="../interfaces/apiheaders.html" class="tsd-signature-type">APIHeaders</a></div>
|
|
238
|
-
<aside class="tsd-sources">
|
|
239
|
-
<ul>
|
|
240
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L113">src/cores/api-service.ts:113</a></li>
|
|
241
|
-
</ul>
|
|
242
|
-
</aside>
|
|
243
|
-
</section>
|
|
244
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
245
|
-
<a name="type" class="tsd-anchor"></a>
|
|
246
|
-
<h3><span class="tsd-flag ts-flagProtected">Protected</span> type</h3>
|
|
247
|
-
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
248
|
-
<aside class="tsd-sources">
|
|
249
|
-
<ul>
|
|
250
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L111">src/cores/api-service.ts:111</a></li>
|
|
251
|
-
</ul>
|
|
252
|
-
</aside>
|
|
253
|
-
</section>
|
|
254
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
|
255
|
-
<a name="apiserviceclientrecorder" class="tsd-anchor"></a>
|
|
256
|
-
<h3><span class="tsd-flag ts-flagStatic">Static</span> APIService<wbr>Client<wbr>Recorder</h3>
|
|
257
|
-
<div class="tsd-signature tsd-kind-icon">APIService<wbr>Client<wbr>Recorder<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous class)</span><span class="tsd-signature-symbol"> = class implements APIServiceClient {public readonly target: APIServiceClient;public readonly endpoint: string;public readonly folder: string;public static next: number = 1;public constructor(target: APIServiceClient, endpoint: string, folder?: string) {this.target = target;this.endpoint = `${endpoint || ''}`;this.folder = `${folder || './logs'}`;}public hello = () => `recorder:${this.target.hello()}`;public async doRecord(method: APIHttpMethod, id: string, cmd?: string, param?: any, body?: any, hash?: string) {const index = APIService.APIServiceClientRecorder.next++;const load = { method, endpoint: `${this.endpoint || ''}`, id, cmd, param, body };const call = async (method: APIHttpMethod) => {if (method == 'GET') return this.target.doGet(id, cmd, param, body, hash);if (method == 'PUT') return this.target.doPut(id, cmd, param, body, hash);if (method == 'POST') return this.target.doPost(id, cmd, param, body, hash);if (method == 'PATCH') return this.target.doPatch(id, cmd, param, body, hash);if (method == 'DELETE') return this.target.doDelete(id, cmd, param, body, hash);throw new Error(`@method is not valid. method:${method}`);};return call(method).then((data: any) => ({ index, load, data, error: null })).catch((error: any) => ({ index, load, data: null, error })).then(({ index, load, data, error }) => {const baseDir = (() => {// eslint-disable-next-line prettier/prettierconst ts = $U.ts().substring(0, '1999-01-01'.length).replace(/\-/ig, '');const fn = `${this.folder}/R${ts}`;if (index <= 1 && !fs.existsSync(`${this.folder}`)) fs.mkdirSync(`${this.folder}`);if (index <= 1 && !fs.existsSync(fn)) fs.mkdirSync(fn);return fn;})();// eslint-disable-next-line prettier/prettierconst message = error instanceof Error ? `${error.message}` : typeof error != 'object' ? `${error}` : error ? JSON.stringify(error) : '';const fn = (n: number): string => {const [S, s] = ['00000', `${n}`];return n > 0 ? `${S.substring(s.length)}${s}` : s.startsWith('-') ? `N${s.substring(1)}` : s;};const file = `${baseDir}/D${fn(index)}.json`;fs.writeFileSync(file, JSON.stringify({ param: load, data, error: message }, null, ' '), 'utf8');if (error) throw error;else return data;});}public async doGet(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.doRecord('GET', id, cmd, param, body, hash);}public async doPut(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.doRecord('PUT', id, cmd, param, body, hash);}public async doPost(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.doRecord('POST', id, cmd, param, body, hash);}public async doPatch(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.doRecord('PATCH', id, cmd, param, body, hash);}public async doDelete(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.doRecord('DELETE', id, cmd, param, body, hash);}}</span></div>
|
|
258
|
-
<aside class="tsd-sources">
|
|
259
|
-
<ul>
|
|
260
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L382">src/cores/api-service.ts:382</a></li>
|
|
261
|
-
</ul>
|
|
262
|
-
</aside>
|
|
263
|
-
<div class="tsd-comment tsd-typography">
|
|
264
|
-
<div class="lead">
|
|
265
|
-
<p>recorder of api-service client.</p>
|
|
266
|
-
</div>
|
|
267
|
-
</div>
|
|
268
|
-
</section>
|
|
269
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
|
270
|
-
<a name="apihttpproxyrecorder" class="tsd-anchor"></a>
|
|
271
|
-
<h3><span class="tsd-flag ts-flagStatic">Static</span> Api<wbr>Http<wbr>Proxy<wbr>Recorder</h3>
|
|
272
|
-
<div class="tsd-signature tsd-kind-icon">Api<wbr>Http<wbr>Proxy<wbr>Recorder<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous class)</span><span class="tsd-signature-symbol"> = class implements ApiHttpProxy {public readonly target: ApiHttpProxy;public readonly folder: string;public static next: number = 1;public constructor(target: ApiHttpProxy, folder?: string) {this.target = target;this.folder = `${folder || './logs'}`;}public hello = () => `recorder:${this.target.hello()}`;public async doProxy<T = any>(method: APIHttpMethod,host: string,path?: string,param?: any,body?: any,context?: any,hash?: string,): Promise<T> {const endpoint =host.startsWith('http://') || host.startsWith('https://') ? `${host}${path}` : `http://${host}${path}`;const index = APIService.ApiHttpProxyRecorder.next++;const load = { method, endpoint, param, body, context };return this.target.doProxy(method, host, path, param, body, context, hash).then((data: any) => ({ index, load, data, error: null })).catch((error: any) => ({ index, load, data: null, error })).then(({ index, load, data, error }) => {const baseDir = (() => {// eslint-disable-next-line prettier/prettierconst ts = $U.ts().substring(0, '1999-01-01'.length).replace(/\-/ig, '');const fn = `${this.folder}/R${ts}`;if (index <= 1 && !fs.existsSync(`${this.folder}`)) fs.mkdirSync(`${this.folder}`);if (index <= 1 && !fs.existsSync(fn)) fs.mkdirSync(fn);return fn;})();// eslint-disable-next-line prettier/prettierconst message = error instanceof Error ? `${error.message}` : typeof error != 'object' ? `${error}` : error ? JSON.stringify(error) : '';const fn = (n: number): string => {const [S, s] = ['00000', `${n}`];return n > 0 ? `${S.substring(s.length)}${s}` : s.startsWith('-') ? `N${s.substring(1)}` : s;};const file = `${baseDir}/P${fn(index)}.json`;fs.writeFileSync(file, JSON.stringify({ param: load, data, error: message }, null, ' '), 'utf8');if (error) throw error;else return data;});}}</span></div>
|
|
273
|
-
<aside class="tsd-sources">
|
|
274
|
-
<ul>
|
|
275
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L330">src/cores/api-service.ts:330</a></li>
|
|
276
|
-
</ul>
|
|
277
|
-
</aside>
|
|
278
|
-
<div class="tsd-comment tsd-typography">
|
|
279
|
-
<div class="lead">
|
|
280
|
-
<p>recorder of api-http-proxy client.</p>
|
|
281
|
-
</div>
|
|
282
|
-
</div>
|
|
283
|
-
</section>
|
|
284
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
|
|
285
|
-
<a name="proxyserviceclient" class="tsd-anchor"></a>
|
|
286
|
-
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> Proxy<wbr>Service<wbr>Client</h3>
|
|
287
|
-
<div class="tsd-signature tsd-kind-icon">Proxy<wbr>Service<wbr>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous class)</span><span class="tsd-signature-symbol"> = class implements APIServiceClient {public readonly proxy: ApiHttpProxy;public readonly base: string;public readonly type: string;public constructor(proxy?: ApiHttpProxy, base?: string, type?: string) {this.proxy = proxy;this.base = base;this.type = type;}protected asPath = (id?: string, cmd?: string) => {const type = this.type;const _isNa = (a: any) => a === undefined || a === null;return ('' +(_isNa(type) ? '' : '/' + encodeURIComponent(type)) +(_isNa(type) || _isNa(id) ? '' : '/' + encodeURIComponent(id)) +(_isNa(type) || _isNa(id) || _isNa(cmd) ? '' : '/' + encodeURI(cmd)) + //NOTE - cmd could have additional '/' char.'');};protected asPath2 = (id?: string, cmd?: string) => {const _isNa = (a: any) => a === undefined || a === null;return ('' +(_isNa(id) ? '' : encodeURIComponent(id)) +(_isNa(id) || _isNa(cmd) ? '' : '/' + encodeURI(cmd)) + //NOTE - cmd could have additional '/' char.'');};protected asHostPath = (id?: string, cmd?: string) => {let host = this.base ? this.base : this.type;let path = this.base ? this.asPath(id, cmd) : this.asPath2(id, cmd);if (this.base) {const url = (!host.startsWith('http') ? 'http://' : '') + `${host}${path || ''}`;const $url = URL.parse(url);host = `${$url.protocol || 'http'}//${$url.hostname}`;path = `${$url.path}`;// console.info(`! asHostPath(${id}, ${cmd})@1 => `, { host, path });} else {// console.info(`! asHostPath(${id}, ${cmd})@2 => `, { host, path });}return { host, path };};public hello = () => `api-client:${this.proxy.hello()}`;public async doGet(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {const { host, path } = this.asHostPath(id, cmd);return this.proxy.doProxy('GET', host, path, param, body, null, hash);}public async doPut(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {const { host, path } = this.asHostPath(id, cmd);return this.proxy.doProxy('PUT', host, path, param, body, null, hash);}public async doPost(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {const { host, path } = this.asHostPath(id, cmd);return this.proxy.doProxy('POST', host, path, param, body, null, hash);}public async doPatch(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {const { host, path } = this.asHostPath(id, cmd);return this.proxy.doProxy('PATCH', host, path, param, body, null, hash);}public async doDelete(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {const { host, path } = this.asHostPath(id, cmd);return this.proxy.doProxy('DELETE', host, path, param, body, null, hash);}}</span></div>
|
|
288
|
-
<aside class="tsd-sources">
|
|
289
|
-
<ul>
|
|
290
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L227">src/cores/api-service.ts:227</a></li>
|
|
291
|
-
</ul>
|
|
292
|
-
</aside>
|
|
293
|
-
<div class="tsd-comment tsd-typography">
|
|
294
|
-
<div class="lead">
|
|
295
|
-
<p>class: <code>TypedEndpoint</code></p>
|
|
296
|
-
<ul>
|
|
297
|
-
<li>by using common proxy, extends endpoint by type.</li>
|
|
298
|
-
<li>endpoint := base+'/'+type.</li>
|
|
299
|
-
</ul>
|
|
300
|
-
</div>
|
|
301
|
-
</div>
|
|
302
|
-
</section>
|
|
303
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
|
304
|
-
<a name="subtypeclient" class="tsd-anchor"></a>
|
|
305
|
-
<h3><span class="tsd-flag ts-flagStatic">Static</span> Sub<wbr>Type<wbr>Client</h3>
|
|
306
|
-
<div class="tsd-signature tsd-kind-icon">Sub<wbr>Type<wbr>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous class)</span><span class="tsd-signature-symbol"> = class implements APIServiceClient {public readonly parent: APIServiceClient;public readonly type: string;public constructor(parent: APIServiceClient, type: string) {this.parent = parent;this.type = `${type || ''}`;}public hello = () => `sub-typed:${this.parent.hello()}`;public asCmd = (id: string, cmd?: string) => {if (id === undefined || id === null) return '';if (id != encodeURI(id)) throw new Error(`@id (string) is not valid format.`);return cmd !== undefined && cmd !== null ? `${id || ''}/${cmd}` : `${id || ''}`;};public async doGet(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.parent.doGet(this.type, this.asCmd(id, cmd), param, body, hash);}public async doPut(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.parent.doPut(this.type, this.asCmd(id, cmd), param, body, hash);}public async doPost(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.parent.doPost(this.type, this.asCmd(id, cmd), param, body, hash);}public async doPatch(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.parent.doPatch(this.type, this.asCmd(id, cmd), param, body, hash);}public async doDelete(id: string, cmd?: string, param?: any, body?: any, hash?: string): Promise<any> {return this.parent.doDelete(this.type, this.asCmd(id, cmd), param, body, hash);}}</span></div>
|
|
307
|
-
<aside class="tsd-sources">
|
|
308
|
-
<ul>
|
|
309
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L297">src/cores/api-service.ts:297</a></li>
|
|
310
|
-
</ul>
|
|
311
|
-
</aside>
|
|
312
|
-
<div class="tsd-comment tsd-typography">
|
|
313
|
-
<div class="lead">
|
|
314
|
-
<p>use sub-typed endpoint.</p>
|
|
315
|
-
<ul>
|
|
316
|
-
<li>extends as endpoint := parent.endpoint + '/' + type</li>
|
|
317
|
-
</ul>
|
|
318
|
-
</div>
|
|
319
|
-
</div>
|
|
320
|
-
</section>
|
|
321
|
-
</section>
|
|
322
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
323
|
-
<h2>Methods</h2>
|
|
324
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
325
|
-
<a name="buildrecorder" class="tsd-anchor"></a>
|
|
326
|
-
<h3>build<wbr>Recorder</h3>
|
|
327
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
328
|
-
<li class="tsd-signature tsd-kind-icon">build<wbr>Recorder<span class="tsd-signature-symbol">(</span>folder<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><a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></li>
|
|
329
|
-
</ul>
|
|
330
|
-
<ul class="tsd-descriptions">
|
|
331
|
-
<li class="tsd-description">
|
|
332
|
-
<aside class="tsd-sources">
|
|
333
|
-
<ul>
|
|
334
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L218">src/cores/api-service.ts:218</a></li>
|
|
335
|
-
</ul>
|
|
336
|
-
</aside>
|
|
337
|
-
<div class="tsd-comment tsd-typography">
|
|
338
|
-
<div class="lead">
|
|
339
|
-
<p>make api recorder of this service.</p>
|
|
340
|
-
</div>
|
|
341
|
-
</div>
|
|
342
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
343
|
-
<ul class="tsd-parameters">
|
|
344
|
-
<li>
|
|
345
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> folder: <span class="tsd-signature-type">string</span></h5>
|
|
346
|
-
<div class="tsd-comment tsd-typography">
|
|
347
|
-
<p>base folder (default <code>./logs</code>)</p>
|
|
348
|
-
</div>
|
|
349
|
-
</li>
|
|
350
|
-
</ul>
|
|
351
|
-
<h4 class="tsd-returns-title">Returns <a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></h4>
|
|
352
|
-
</li>
|
|
353
|
-
</ul>
|
|
354
|
-
</section>
|
|
355
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
356
|
-
<a name="buildsubtypeclient" class="tsd-anchor"></a>
|
|
357
|
-
<h3>build<wbr>Sub<wbr>Type<wbr>Client</h3>
|
|
358
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
359
|
-
<li class="tsd-signature tsd-kind-icon">build<wbr>Sub<wbr>Type<wbr>Client<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useRecord<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, folder<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><a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></li>
|
|
360
|
-
</ul>
|
|
361
|
-
<ul class="tsd-descriptions">
|
|
362
|
-
<li class="tsd-description">
|
|
363
|
-
<aside class="tsd-sources">
|
|
364
|
-
<ul>
|
|
365
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L209">src/cores/api-service.ts:209</a></li>
|
|
366
|
-
</ul>
|
|
367
|
-
</aside>
|
|
368
|
-
<div class="tsd-comment tsd-typography">
|
|
369
|
-
<div class="lead">
|
|
370
|
-
<p>make a client for sub-typed endpoint.</p>
|
|
371
|
-
</div>
|
|
372
|
-
</div>
|
|
373
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
374
|
-
<ul class="tsd-parameters">
|
|
375
|
-
<li>
|
|
376
|
-
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
377
|
-
<div class="tsd-comment tsd-typography">
|
|
378
|
-
<p>sub-type path.</p>
|
|
379
|
-
</div>
|
|
380
|
-
</li>
|
|
381
|
-
<li>
|
|
382
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useRecord: <span class="tsd-signature-type">boolean</span></h5>
|
|
383
|
-
</li>
|
|
384
|
-
<li>
|
|
385
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> folder: <span class="tsd-signature-type">string</span></h5>
|
|
386
|
-
</li>
|
|
387
|
-
</ul>
|
|
388
|
-
<h4 class="tsd-returns-title">Returns <a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></h4>
|
|
389
|
-
</li>
|
|
390
|
-
</ul>
|
|
391
|
-
</section>
|
|
392
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
393
|
-
<a name="dodelete" class="tsd-anchor"></a>
|
|
394
|
-
<h3>do<wbr>Delete</h3>
|
|
395
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
396
|
-
<li class="tsd-signature tsd-kind-icon">do<wbr>Delete<span class="tsd-signature-symbol">(</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>, $param<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, $body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, hash<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">any</span><span class="tsd-signature-symbol">></span></li>
|
|
397
|
-
</ul>
|
|
398
|
-
<ul class="tsd-descriptions">
|
|
399
|
-
<li class="tsd-description">
|
|
400
|
-
<aside class="tsd-sources">
|
|
401
|
-
<p>Implementation of <a href="../interfaces/apiserviceclient.html">APIServiceClient</a>.<a href="../interfaces/apiserviceclient.html#dodelete">doDelete</a></p>
|
|
402
|
-
<ul>
|
|
403
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L476">src/cores/api-service.ts:476</a></li>
|
|
404
|
-
</ul>
|
|
405
|
-
</aside>
|
|
406
|
-
<div class="tsd-comment tsd-typography">
|
|
407
|
-
<div class="lead">
|
|
408
|
-
<p>DELETE HOST/PATH?$param</p>
|
|
409
|
-
</div>
|
|
410
|
-
</div>
|
|
411
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
412
|
-
<ul class="tsd-parameters">
|
|
413
|
-
<li>
|
|
414
|
-
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
415
|
-
</li>
|
|
416
|
-
<li>
|
|
417
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cmd: <span class="tsd-signature-type">string</span></h5>
|
|
418
|
-
</li>
|
|
419
|
-
<li>
|
|
420
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $param: <span class="tsd-signature-type">any</span></h5>
|
|
421
|
-
</li>
|
|
422
|
-
<li>
|
|
423
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $body: <span class="tsd-signature-type">any</span></h5>
|
|
424
|
-
</li>
|
|
425
|
-
<li>
|
|
426
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> hash: <span class="tsd-signature-type">string</span></h5>
|
|
427
|
-
</li>
|
|
428
|
-
</ul>
|
|
429
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
430
|
-
</li>
|
|
431
|
-
</ul>
|
|
432
|
-
</section>
|
|
433
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
434
|
-
<a name="doget" class="tsd-anchor"></a>
|
|
435
|
-
<h3>do<wbr>Get</h3>
|
|
436
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
437
|
-
<li class="tsd-signature tsd-kind-icon">do<wbr>Get<span class="tsd-signature-symbol">(</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>, $param<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, $body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, hash<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">any</span><span class="tsd-signature-symbol">></span></li>
|
|
438
|
-
</ul>
|
|
439
|
-
<ul class="tsd-descriptions">
|
|
440
|
-
<li class="tsd-description">
|
|
441
|
-
<aside class="tsd-sources">
|
|
442
|
-
<p>Implementation of <a href="../interfaces/apiserviceclient.html">APIServiceClient</a>.<a href="../interfaces/apiserviceclient.html#doget">doGet</a></p>
|
|
443
|
-
<ul>
|
|
444
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L448">src/cores/api-service.ts:448</a></li>
|
|
445
|
-
</ul>
|
|
446
|
-
</aside>
|
|
447
|
-
<div class="tsd-comment tsd-typography">
|
|
448
|
-
<div class="lead">
|
|
449
|
-
<p>GET HOST/PATH?$param</p>
|
|
450
|
-
</div>
|
|
451
|
-
</div>
|
|
452
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
453
|
-
<ul class="tsd-parameters">
|
|
454
|
-
<li>
|
|
455
|
-
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
456
|
-
</li>
|
|
457
|
-
<li>
|
|
458
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cmd: <span class="tsd-signature-type">string</span></h5>
|
|
459
|
-
</li>
|
|
460
|
-
<li>
|
|
461
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $param: <span class="tsd-signature-type">any</span></h5>
|
|
462
|
-
</li>
|
|
463
|
-
<li>
|
|
464
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $body: <span class="tsd-signature-type">any</span></h5>
|
|
465
|
-
</li>
|
|
466
|
-
<li>
|
|
467
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> hash: <span class="tsd-signature-type">string</span></h5>
|
|
468
|
-
</li>
|
|
469
|
-
</ul>
|
|
470
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
471
|
-
</li>
|
|
472
|
-
</ul>
|
|
473
|
-
</section>
|
|
474
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
475
|
-
<a name="dopatch" class="tsd-anchor"></a>
|
|
476
|
-
<h3>do<wbr>Patch</h3>
|
|
477
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
478
|
-
<li class="tsd-signature tsd-kind-icon">do<wbr>Patch<span class="tsd-signature-symbol">(</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>, $param<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, $body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, hash<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">any</span><span class="tsd-signature-symbol">></span></li>
|
|
479
|
-
</ul>
|
|
480
|
-
<ul class="tsd-descriptions">
|
|
481
|
-
<li class="tsd-description">
|
|
482
|
-
<aside class="tsd-sources">
|
|
483
|
-
<p>Implementation of <a href="../interfaces/apiserviceclient.html">APIServiceClient</a>.<a href="../interfaces/apiserviceclient.html#dopatch">doPatch</a></p>
|
|
484
|
-
<ul>
|
|
485
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L469">src/cores/api-service.ts:469</a></li>
|
|
486
|
-
</ul>
|
|
487
|
-
</aside>
|
|
488
|
-
<div class="tsd-comment tsd-typography">
|
|
489
|
-
<div class="lead">
|
|
490
|
-
<p>PATCH HOST/PATH?$param</p>
|
|
491
|
-
</div>
|
|
492
|
-
</div>
|
|
493
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
494
|
-
<ul class="tsd-parameters">
|
|
495
|
-
<li>
|
|
496
|
-
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
497
|
-
</li>
|
|
498
|
-
<li>
|
|
499
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cmd: <span class="tsd-signature-type">string</span></h5>
|
|
500
|
-
</li>
|
|
501
|
-
<li>
|
|
502
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $param: <span class="tsd-signature-type">any</span></h5>
|
|
503
|
-
</li>
|
|
504
|
-
<li>
|
|
505
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $body: <span class="tsd-signature-type">any</span></h5>
|
|
506
|
-
</li>
|
|
507
|
-
<li>
|
|
508
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> hash: <span class="tsd-signature-type">string</span></h5>
|
|
509
|
-
</li>
|
|
510
|
-
</ul>
|
|
511
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
512
|
-
</li>
|
|
513
|
-
</ul>
|
|
514
|
-
</section>
|
|
515
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
516
|
-
<a name="dopost" class="tsd-anchor"></a>
|
|
517
|
-
<h3>do<wbr>Post</h3>
|
|
518
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
519
|
-
<li class="tsd-signature tsd-kind-icon">do<wbr>Post<span class="tsd-signature-symbol">(</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>, $param<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, $body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, hash<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">any</span><span class="tsd-signature-symbol">></span></li>
|
|
520
|
-
</ul>
|
|
521
|
-
<ul class="tsd-descriptions">
|
|
522
|
-
<li class="tsd-description">
|
|
523
|
-
<aside class="tsd-sources">
|
|
524
|
-
<p>Implementation of <a href="../interfaces/apiserviceclient.html">APIServiceClient</a>.<a href="../interfaces/apiserviceclient.html#dopost">doPost</a></p>
|
|
525
|
-
<ul>
|
|
526
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L462">src/cores/api-service.ts:462</a></li>
|
|
527
|
-
</ul>
|
|
528
|
-
</aside>
|
|
529
|
-
<div class="tsd-comment tsd-typography">
|
|
530
|
-
<div class="lead">
|
|
531
|
-
<p>POST HOST/PATH?$param</p>
|
|
532
|
-
</div>
|
|
533
|
-
</div>
|
|
534
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
535
|
-
<ul class="tsd-parameters">
|
|
536
|
-
<li>
|
|
537
|
-
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
538
|
-
</li>
|
|
539
|
-
<li>
|
|
540
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cmd: <span class="tsd-signature-type">string</span></h5>
|
|
541
|
-
</li>
|
|
542
|
-
<li>
|
|
543
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $param: <span class="tsd-signature-type">any</span></h5>
|
|
544
|
-
</li>
|
|
545
|
-
<li>
|
|
546
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $body: <span class="tsd-signature-type">any</span></h5>
|
|
547
|
-
</li>
|
|
548
|
-
<li>
|
|
549
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> hash: <span class="tsd-signature-type">string</span></h5>
|
|
550
|
-
</li>
|
|
551
|
-
</ul>
|
|
552
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
553
|
-
</li>
|
|
554
|
-
</ul>
|
|
555
|
-
</section>
|
|
556
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
557
|
-
<a name="doput" class="tsd-anchor"></a>
|
|
558
|
-
<h3>do<wbr>Put</h3>
|
|
559
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
560
|
-
<li class="tsd-signature tsd-kind-icon">do<wbr>Put<span class="tsd-signature-symbol">(</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>, $param<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, $body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, hash<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">any</span><span class="tsd-signature-symbol">></span></li>
|
|
561
|
-
</ul>
|
|
562
|
-
<ul class="tsd-descriptions">
|
|
563
|
-
<li class="tsd-description">
|
|
564
|
-
<aside class="tsd-sources">
|
|
565
|
-
<p>Implementation of <a href="../interfaces/apiserviceclient.html">APIServiceClient</a>.<a href="../interfaces/apiserviceclient.html#doput">doPut</a></p>
|
|
566
|
-
<ul>
|
|
567
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L455">src/cores/api-service.ts:455</a></li>
|
|
568
|
-
</ul>
|
|
569
|
-
</aside>
|
|
570
|
-
<div class="tsd-comment tsd-typography">
|
|
571
|
-
<div class="lead">
|
|
572
|
-
<p>PUT HOST/PATH?$param</p>
|
|
573
|
-
</div>
|
|
574
|
-
</div>
|
|
575
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
576
|
-
<ul class="tsd-parameters">
|
|
577
|
-
<li>
|
|
578
|
-
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
579
|
-
</li>
|
|
580
|
-
<li>
|
|
581
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cmd: <span class="tsd-signature-type">string</span></h5>
|
|
582
|
-
</li>
|
|
583
|
-
<li>
|
|
584
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $param: <span class="tsd-signature-type">any</span></h5>
|
|
585
|
-
</li>
|
|
586
|
-
<li>
|
|
587
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> $body: <span class="tsd-signature-type">any</span></h5>
|
|
588
|
-
</li>
|
|
589
|
-
<li>
|
|
590
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> hash: <span class="tsd-signature-type">string</span></h5>
|
|
591
|
-
</li>
|
|
592
|
-
</ul>
|
|
593
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
594
|
-
</li>
|
|
595
|
-
</ul>
|
|
596
|
-
</section>
|
|
597
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
598
|
-
<a name="hello" class="tsd-anchor"></a>
|
|
599
|
-
<h3>hello</h3>
|
|
600
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
601
|
-
<li class="tsd-signature tsd-kind-icon">hello<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
602
|
-
</ul>
|
|
603
|
-
<ul class="tsd-descriptions">
|
|
604
|
-
<li class="tsd-description">
|
|
605
|
-
<aside class="tsd-sources">
|
|
606
|
-
<p>Implementation of <a href="../interfaces/apiserviceclient.html">APIServiceClient</a>.<a href="../interfaces/apiserviceclient.html#hello">hello</a></p>
|
|
607
|
-
<ul>
|
|
608
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L164">src/cores/api-service.ts:164</a></li>
|
|
609
|
-
</ul>
|
|
610
|
-
</aside>
|
|
611
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
612
|
-
</li>
|
|
613
|
-
</ul>
|
|
614
|
-
</section>
|
|
615
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
616
|
-
<a name="buildclient" class="tsd-anchor"></a>
|
|
617
|
-
<h3><span class="tsd-flag ts-flagStatic">Static</span> build<wbr>Client</h3>
|
|
618
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
619
|
-
<li class="tsd-signature tsd-kind-icon">build<wbr>Client<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, headers<span class="tsd-signature-symbol">?: </span><a href="../interfaces/apiheaders.html" class="tsd-signature-type">APIHeaders</a>, backbone<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, proxy<span class="tsd-signature-symbol">?: </span><a href="../interfaces/apihttpproxy.html" class="tsd-signature-type">ApiHttpProxy</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></li>
|
|
620
|
-
</ul>
|
|
621
|
-
<ul class="tsd-descriptions">
|
|
622
|
-
<li class="tsd-description">
|
|
623
|
-
<aside class="tsd-sources">
|
|
624
|
-
<ul>
|
|
625
|
-
<li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/a65cfcc/src/cores/api-service.ts#L171">src/cores/api-service.ts:171</a></li>
|
|
626
|
-
</ul>
|
|
627
|
-
</aside>
|
|
628
|
-
<div class="tsd-comment tsd-typography">
|
|
629
|
-
<div class="lead">
|
|
630
|
-
<p>helper to make http client</p>
|
|
631
|
-
</div>
|
|
632
|
-
</div>
|
|
633
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
634
|
-
<ul class="tsd-parameters">
|
|
635
|
-
<li>
|
|
636
|
-
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
637
|
-
</li>
|
|
638
|
-
<li>
|
|
639
|
-
<h5>endpoint: <span class="tsd-signature-type">string</span></h5>
|
|
640
|
-
</li>
|
|
641
|
-
<li>
|
|
642
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> headers: <a href="../interfaces/apiheaders.html" class="tsd-signature-type">APIHeaders</a></h5>
|
|
643
|
-
</li>
|
|
644
|
-
<li>
|
|
645
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> backbone: <span class="tsd-signature-type">string</span></h5>
|
|
646
|
-
<div class="tsd-comment tsd-typography">
|
|
647
|
-
<p>backbone address like '<a href="http://localhost:8081'">http://localhost:8081'</a></p>
|
|
648
|
-
</div>
|
|
649
|
-
</li>
|
|
650
|
-
<li>
|
|
651
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> proxy: <a href="../interfaces/apihttpproxy.html" class="tsd-signature-type">ApiHttpProxy</a></h5>
|
|
652
|
-
</li>
|
|
653
|
-
</ul>
|
|
654
|
-
<h4 class="tsd-returns-title">Returns <a href="../interfaces/apiserviceclient.html" class="tsd-signature-type">APIServiceClient</a></h4>
|
|
655
|
-
</li>
|
|
656
|
-
</ul>
|
|
657
|
-
</section>
|
|
658
|
-
</section>
|
|
659
|
-
</div>
|
|
660
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
661
|
-
<nav class="tsd-navigation primary">
|
|
662
|
-
<ul>
|
|
663
|
-
<li class="globals ">
|
|
664
|
-
<a href="../globals.html"><em>Globals</em></a>
|
|
665
|
-
</li>
|
|
666
|
-
</ul>
|
|
667
|
-
</nav>
|
|
668
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
669
|
-
<ul class="before-current">
|
|
670
|
-
</ul>
|
|
671
|
-
<ul class="current">
|
|
672
|
-
<li class="current tsd-kind-class">
|
|
673
|
-
<a href="apiservice.html" class="tsd-kind-icon">APIService</a>
|
|
674
|
-
<ul>
|
|
675
|
-
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
676
|
-
<a href="apiservice.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
677
|
-
</li>
|
|
678
|
-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
679
|
-
<a href="apiservice.html#client" class="tsd-kind-icon">client</a>
|
|
680
|
-
</li>
|
|
681
|
-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
682
|
-
<a href="apiservice.html#endpoint" class="tsd-kind-icon">endpoint</a>
|
|
683
|
-
</li>
|
|
684
|
-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
685
|
-
<a href="apiservice.html#headers" class="tsd-kind-icon">headers</a>
|
|
686
|
-
</li>
|
|
687
|
-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
688
|
-
<a href="apiservice.html#type" class="tsd-kind-icon">type</a>
|
|
689
|
-
</li>
|
|
690
|
-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
|
691
|
-
<a href="apiservice.html#apiserviceclientrecorder" class="tsd-kind-icon">APIService<wbr>Client<wbr>Recorder</a>
|
|
692
|
-
</li>
|
|
693
|
-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
|
694
|
-
<a href="apiservice.html#apihttpproxyrecorder" class="tsd-kind-icon">Api<wbr>Http<wbr>Proxy<wbr>Recorder</a>
|
|
695
|
-
</li>
|
|
696
|
-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
|
|
697
|
-
<a href="apiservice.html#proxyserviceclient" class="tsd-kind-icon">Proxy<wbr>Service<wbr>Client</a>
|
|
698
|
-
</li>
|
|
699
|
-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
|
700
|
-
<a href="apiservice.html#subtypeclient" class="tsd-kind-icon">Sub<wbr>Type<wbr>Client</a>
|
|
701
|
-
</li>
|
|
702
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
703
|
-
<a href="apiservice.html#buildrecorder" class="tsd-kind-icon">build<wbr>Recorder</a>
|
|
704
|
-
</li>
|
|
705
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
706
|
-
<a href="apiservice.html#buildsubtypeclient" class="tsd-kind-icon">build<wbr>Sub<wbr>Type<wbr>Client</a>
|
|
707
|
-
</li>
|
|
708
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
709
|
-
<a href="apiservice.html#dodelete" class="tsd-kind-icon">do<wbr>Delete</a>
|
|
710
|
-
</li>
|
|
711
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
712
|
-
<a href="apiservice.html#doget" class="tsd-kind-icon">do<wbr>Get</a>
|
|
713
|
-
</li>
|
|
714
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
715
|
-
<a href="apiservice.html#dopatch" class="tsd-kind-icon">do<wbr>Patch</a>
|
|
716
|
-
</li>
|
|
717
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
718
|
-
<a href="apiservice.html#dopost" class="tsd-kind-icon">do<wbr>Post</a>
|
|
719
|
-
</li>
|
|
720
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
721
|
-
<a href="apiservice.html#doput" class="tsd-kind-icon">do<wbr>Put</a>
|
|
722
|
-
</li>
|
|
723
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
724
|
-
<a href="apiservice.html#hello" class="tsd-kind-icon">hello</a>
|
|
725
|
-
</li>
|
|
726
|
-
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
727
|
-
<a href="apiservice.html#buildclient" class="tsd-kind-icon">build<wbr>Client</a>
|
|
728
|
-
</li>
|
|
729
|
-
</ul>
|
|
730
|
-
</li>
|
|
731
|
-
</ul>
|
|
732
|
-
<ul class="after-current">
|
|
733
|
-
</ul>
|
|
734
|
-
</nav>
|
|
735
|
-
</div>
|
|
736
|
-
</div>
|
|
737
|
-
</div>
|
|
738
|
-
<footer class="with-border-bottom">
|
|
739
|
-
<div class="container">
|
|
740
|
-
<h2>Legend</h2>
|
|
741
|
-
<div class="tsd-legend-group">
|
|
742
|
-
<ul class="tsd-legend">
|
|
743
|
-
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
|
744
|
-
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
745
|
-
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
746
|
-
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
747
|
-
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
748
|
-
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
|
749
|
-
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
750
|
-
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
|
751
|
-
</ul>
|
|
752
|
-
<ul class="tsd-legend">
|
|
753
|
-
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
754
|
-
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
|
755
|
-
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
|
756
|
-
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
|
757
|
-
</ul>
|
|
758
|
-
<ul class="tsd-legend">
|
|
759
|
-
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
760
|
-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
761
|
-
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
|
762
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
763
|
-
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
764
|
-
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
|
765
|
-
</ul>
|
|
766
|
-
<ul class="tsd-legend">
|
|
767
|
-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
768
|
-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
769
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
770
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
771
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
772
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
773
|
-
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
|
774
|
-
</ul>
|
|
775
|
-
<ul class="tsd-legend">
|
|
776
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
777
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
778
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
779
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
|
780
|
-
</ul>
|
|
781
|
-
<ul class="tsd-legend">
|
|
782
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
783
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|
784
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
|
785
|
-
</ul>
|
|
786
|
-
<ul class="tsd-legend">
|
|
787
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
788
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
789
|
-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
|
790
|
-
</ul>
|
|
791
|
-
<ul class="tsd-legend">
|
|
792
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
793
|
-
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
794
|
-
</ul>
|
|
795
|
-
</div>
|
|
796
|
-
</div>
|
|
797
|
-
</footer>
|
|
798
|
-
<div class="container tsd-generator">
|
|
799
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
800
|
-
</div>
|
|
801
|
-
<div class="overlay"></div>
|
|
802
|
-
<script src="../assets/js/main.js"></script>
|
|
803
|
-
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
804
|
-
</body>
|
|
805
|
-
</html>
|