lemon-core 4.2.2 → 4.2.3

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.
Files changed (730) hide show
  1. package/README.md +1 -0
  2. package/dist/common/runtime-helper.d.ts +84 -0
  3. package/dist/common/runtime-helper.js +172 -0
  4. package/dist/common/runtime-helper.js.map +1 -0
  5. package/dist/common/test-helper.d.ts +5 -2
  6. package/dist/common/test-helper.js +6 -3
  7. package/dist/common/test-helper.js.map +1 -1
  8. package/dist/cores/lambda/jwt-secret.d.ts +10 -0
  9. package/dist/cores/lambda/jwt-secret.js +25 -0
  10. package/dist/cores/lambda/jwt-secret.js.map +1 -0
  11. package/dist/cores/lambda/lambda-web-handler.d.ts +1 -1
  12. package/dist/cores/storage/storage-service.d.ts +5 -5
  13. package/dist/cores/storage/storage-service.js +4 -4
  14. package/dist/cores/storage/storage-service.js.map +1 -1
  15. package/dist/docs/.nojekyll +1 -0
  16. package/dist/docs/assets/hierarchy.js +1 -0
  17. package/dist/docs/assets/highlight.css +141 -0
  18. package/dist/docs/assets/icons.js +18 -0
  19. package/dist/docs/assets/icons.svg +1 -0
  20. package/dist/docs/assets/main.js +60 -0
  21. package/dist/docs/assets/navigation.js +1 -0
  22. package/dist/docs/assets/search.js +1 -0
  23. package/dist/docs/assets/style.css +1633 -0
  24. package/dist/docs/classes/APIProxyClient.html +13 -0
  25. package/dist/docs/classes/APIService.html +51 -0
  26. package/dist/docs/classes/AWSKMSService.html +46 -0
  27. package/dist/docs/classes/AWSModule.html +20 -0
  28. package/dist/docs/classes/AWSS3Service.html +45 -0
  29. package/dist/docs/classes/AWSSNSService.html +31 -0
  30. package/dist/docs/classes/AWSSQSService.html +27 -0
  31. package/dist/docs/classes/AbstractElastic6Instance.html +36 -0
  32. package/dist/docs/classes/AbstractManager.html +91 -0
  33. package/dist/docs/classes/AbstractProxy.html +56 -0
  34. package/dist/docs/classes/AbstractTransformer.html +23 -0
  35. package/dist/docs/classes/CacheService.html +88 -0
  36. package/dist/docs/classes/ConfigModule.html +17 -0
  37. package/dist/docs/classes/CoreManager.html +109 -0
  38. package/dist/docs/classes/CoreService.html +28 -0
  39. package/dist/docs/classes/DummyCacheService.html +84 -0
  40. package/dist/docs/classes/DummyController.html +42 -0
  41. package/dist/docs/classes/DummyDynamoService.html +90 -0
  42. package/dist/docs/classes/DummyElastic6Service.html +119 -0
  43. package/dist/docs/classes/DummyRedisStorageService.html +42 -0
  44. package/dist/docs/classes/DummyStorageService.html +47 -0
  45. package/dist/docs/classes/DynamoQueryService.html +25 -0
  46. package/dist/docs/classes/DynamoScanService.html +13 -0
  47. package/dist/docs/classes/DynamoService.html +82 -0
  48. package/dist/docs/classes/DynamoStorageService.html +44 -0
  49. package/dist/docs/classes/Elastic6Instance.html +49 -0
  50. package/dist/docs/classes/Elastic6QueryService.html +59 -0
  51. package/dist/docs/classes/Elastic6Service.html +124 -0
  52. package/dist/docs/classes/Elastic6Synchronizer.html +13 -0
  53. package/dist/docs/classes/ElasticIndexService.html +56 -0
  54. package/dist/docs/classes/GeneralAPIController.html +61 -0
  55. package/dist/docs/classes/GeneralController.html +27 -0
  56. package/dist/docs/classes/GeneralKeyMaker.html +12 -0
  57. package/dist/docs/classes/GeneralModelFilter.html +39 -0
  58. package/dist/docs/classes/GeneralWEBController.html +40 -0
  59. package/dist/docs/classes/HangulService.html +70 -0
  60. package/dist/docs/classes/HttpStorageService.html +34 -0
  61. package/dist/docs/classes/LambdaALBHandler.html +32 -0
  62. package/dist/docs/classes/LambdaCognitoHandler.html +13 -0
  63. package/dist/docs/classes/LambdaDynamoStreamHandler.html +25 -0
  64. package/dist/docs/classes/LambdaHandler.html +36 -0
  65. package/dist/docs/classes/LambdaModule.html +26 -0
  66. package/dist/docs/classes/LambdaNotificationHandler.html +22 -0
  67. package/dist/docs/classes/LambdaSNSHandler.html +15 -0
  68. package/dist/docs/classes/LambdaSQSHandler.html +15 -0
  69. package/dist/docs/classes/LambdaSubHandler.html +10 -0
  70. package/dist/docs/classes/LambdaWEBHandler.html +37 -0
  71. package/dist/docs/classes/LambdaWSSHandler.html +17 -0
  72. package/dist/docs/classes/ManagerProxy.html +51 -0
  73. package/dist/docs/classes/MocksAPIService.html +29 -0
  74. package/dist/docs/classes/ModelUtil.html +13 -0
  75. package/dist/docs/classes/ProtocolModule.html +17 -0
  76. package/dist/docs/classes/ProxyStorageService.html +133 -0
  77. package/dist/docs/classes/RedisStorageService.html +38 -0
  78. package/dist/docs/classes/TypedStorageService.html +89 -0
  79. package/dist/docs/classes/UniqueFieldManager.html +35 -0
  80. package/dist/docs/classes/_web.MyHttpHeaderTool.html +82 -0
  81. package/dist/docs/classes/elasticsearch.BaseConnectionPool.html +39 -0
  82. package/dist/docs/classes/elasticsearch.Client.html +110 -0
  83. package/dist/docs/classes/elasticsearch.CloudConnectionPool.html +40 -0
  84. package/dist/docs/classes/elasticsearch.Connection.html +22 -0
  85. package/dist/docs/classes/elasticsearch.ConnectionPool.html +50 -0
  86. package/dist/docs/classes/elasticsearch.Serializer.html +6 -0
  87. package/dist/docs/classes/elasticsearch.Transport.html +20 -0
  88. package/dist/docs/classes/elasticsearch.errors.ConfigurationError.html +33 -0
  89. package/dist/docs/classes/elasticsearch.errors.ConnectionError.html +34 -0
  90. package/dist/docs/classes/elasticsearch.errors.DeserializationError.html +34 -0
  91. package/dist/docs/classes/elasticsearch.errors.ElasticsearchClientError.html +33 -0
  92. package/dist/docs/classes/elasticsearch.errors.NoLivingConnectionsError.html +34 -0
  93. package/dist/docs/classes/elasticsearch.errors.RequestAbortedError.html +34 -0
  94. package/dist/docs/classes/elasticsearch.errors.ResponseError.html +37 -0
  95. package/dist/docs/classes/elasticsearch.errors.SerializationError.html +34 -0
  96. package/dist/docs/classes/elasticsearch.errors.TimeoutError.html +34 -0
  97. package/dist/docs/functions/GETERR.html +5 -0
  98. package/dist/docs/functions/GETERR_.html +5 -0
  99. package/dist/docs/functions/NUL404.html +3 -0
  100. package/dist/docs/functions/_ES6.html +7 -0
  101. package/dist/docs/functions/_event.html +4 -0
  102. package/dist/docs/functions/_info.html +2 -0
  103. package/dist/docs/functions/_it.html +2 -0
  104. package/dist/docs/functions/_protocol.html +5 -0
  105. package/dist/docs/functions/_slack.html +6 -0
  106. package/dist/docs/functions/_web.buildResponse.html +9 -0
  107. package/dist/docs/functions/_web.failure.html +1 -0
  108. package/dist/docs/functions/_web.mxNextFailure.html +2 -0
  109. package/dist/docs/functions/_web.mxNextHandler.html +2 -0
  110. package/dist/docs/functions/_web.notfound.html +1 -0
  111. package/dist/docs/functions/_web.promised.html +4 -0
  112. package/dist/docs/functions/_web.redirect.html +1 -0
  113. package/dist/docs/functions/_web.success.html +1 -0
  114. package/dist/docs/functions/_wss.buildResponse.html +1 -0
  115. package/dist/docs/functions/_wss.failure.html +1 -0
  116. package/dist/docs/functions/_wss.notfound.html +1 -0
  117. package/dist/docs/functions/_wss.success.html +1 -0
  118. package/dist/docs/functions/asErrorPayload.html +2 -0
  119. package/dist/docs/functions/asIdentityId.html +3 -0
  120. package/dist/docs/functions/asyncCredentials.html +5 -0
  121. package/dist/docs/functions/awsConfig.html +10 -0
  122. package/dist/docs/functions/buildEngine.html +7 -0
  123. package/dist/docs/functions/buildExpress.html +4 -0
  124. package/dist/docs/functions/buildReportError.html +4 -0
  125. package/dist/docs/functions/convDate.html +1 -0
  126. package/dist/docs/functions/convDateToTS.html +5 -0
  127. package/dist/docs/functions/convDateToTime.html +3 -0
  128. package/dist/docs/functions/createHttpWebProxy.html +11 -0
  129. package/dist/docs/functions/createSigV4Proxy.html +14 -0
  130. package/dist/docs/functions/doReportCallback.html +4 -0
  131. package/dist/docs/functions/doReportError.html +6 -0
  132. package/dist/docs/functions/doReportMetric.html +6 -0
  133. package/dist/docs/functions/doReportSlack.html +5 -0
  134. package/dist/docs/functions/do_parallel.html +8 -0
  135. package/dist/docs/functions/environ.html +3 -0
  136. package/dist/docs/functions/expect2.html +4 -0
  137. package/dist/docs/functions/filterFields.html +5 -0
  138. package/dist/docs/functions/fromTTL.html +4 -0
  139. package/dist/docs/functions/getHelloArn.html +4 -0
  140. package/dist/docs/functions/getIdentityId.html +3 -0
  141. package/dist/docs/functions/isLambda.html +5 -0
  142. package/dist/docs/functions/isUserAuthorized.html +8 -0
  143. package/dist/docs/functions/lib.toDDB.html +2 -0
  144. package/dist/docs/functions/lib.toJavascript.html +2 -0
  145. package/dist/docs/functions/loadDataYml.html +2 -0
  146. package/dist/docs/functions/loadJsonSync.html +2 -0
  147. package/dist/docs/functions/marshal.html +6 -0
  148. package/dist/docs/functions/my_parallel.html +13 -0
  149. package/dist/docs/functions/my_sequence.html +8 -0
  150. package/dist/docs/functions/onlyDefined.html +2 -0
  151. package/dist/docs/functions/parseRange.html +3 -0
  152. package/dist/docs/functions/sleep.html +3 -0
  153. package/dist/docs/functions/sourceToItem.html +7 -0
  154. package/dist/docs/functions/toTTL.html +4 -0
  155. package/dist/docs/functions/waited.html +5 -0
  156. package/dist/docs/hierarchy.html +1 -0
  157. package/dist/docs/index.html +366 -0
  158. package/dist/docs/interfaces/APIHeaders.html +2 -0
  159. package/dist/docs/interfaces/APIServiceClient.html +11 -0
  160. package/dist/docs/interfaces/ApiHttpProxy.html +17 -0
  161. package/dist/docs/interfaces/AutocompleteSearchParam.html +19 -0
  162. package/dist/docs/interfaces/AwsConfigParams.html +12 -0
  163. package/dist/docs/interfaces/BatchResult.html +8 -0
  164. package/dist/docs/interfaces/Body.html +7 -0
  165. package/dist/docs/interfaces/BuildExpressOptions.html +13 -0
  166. package/dist/docs/interfaces/CacheEntry.html +8 -0
  167. package/dist/docs/interfaces/CacheKeyMakable.html +10 -0
  168. package/dist/docs/interfaces/CacheOptions.html +10 -0
  169. package/dist/docs/interfaces/CacheSupportable.html +14 -0
  170. package/dist/docs/interfaces/CallbackData.html +12 -0
  171. package/dist/docs/interfaces/CallbackParam.html +11 -0
  172. package/dist/docs/interfaces/CoreConfigService.html +15 -0
  173. package/dist/docs/interfaces/CoreKey.html +13 -0
  174. package/dist/docs/interfaces/CoreKeyMakeable.html +13 -0
  175. package/dist/docs/interfaces/CoreKmsService.html +8 -0
  176. package/dist/docs/interfaces/CoreModel.html +40 -0
  177. package/dist/docs/interfaces/CoreModelFilterable.html +10 -0
  178. package/dist/docs/interfaces/CoreModifier.html +11 -0
  179. package/dist/docs/interfaces/CoreServices.html +6 -0
  180. package/dist/docs/interfaces/CoreSnsService.html +8 -0
  181. package/dist/docs/interfaces/CoreWEBController.html +8 -0
  182. package/dist/docs/interfaces/Cores.html +17 -0
  183. package/dist/docs/interfaces/CronEvent.html +6 -0
  184. package/dist/docs/interfaces/CronParam.html +3 -0
  185. package/dist/docs/interfaces/DynamoOption.html +6 -0
  186. package/dist/docs/interfaces/DynamoQueryResult.html +8 -0
  187. package/dist/docs/interfaces/DynamoScanResult.html +8 -0
  188. package/dist/docs/interfaces/DynamoSimpleQueriable.html +15 -0
  189. package/dist/docs/interfaces/DynamoSimpleScannable.html +10 -0
  190. package/dist/docs/interfaces/DynamoStreamBody.html +9 -0
  191. package/dist/docs/interfaces/DynamoStreamCallback.html +1 -0
  192. package/dist/docs/interfaces/DynamoStreamFilter.html +2 -0
  193. package/dist/docs/interfaces/DynamoStreamParam.html +5 -0
  194. package/dist/docs/interfaces/Elastic6ContructParams.html +17 -0
  195. package/dist/docs/interfaces/Elastic6Item.html +6 -0
  196. package/dist/docs/interfaces/Elastic6Option.html +24 -0
  197. package/dist/docs/interfaces/Elastic6SearchParams.html +8 -0
  198. package/dist/docs/interfaces/Elastic6SimpleQueriable.html +11 -0
  199. package/dist/docs/interfaces/ElasticItem.html +6 -0
  200. package/dist/docs/interfaces/ElasticOption.html +22 -0
  201. package/dist/docs/interfaces/EngineConsole.html +12 -0
  202. package/dist/docs/interfaces/EngineCore.html +15 -0
  203. package/dist/docs/interfaces/EngineModule.html +15 -0
  204. package/dist/docs/interfaces/EngineModules.html +14 -0
  205. package/dist/docs/interfaces/EngineOption.html +8 -0
  206. package/dist/docs/interfaces/EngineScope.html +6 -0
  207. package/dist/docs/interfaces/ExpressFactory.html +5 -0
  208. package/dist/docs/interfaces/ExpressFactoryResult.html +11 -0
  209. package/dist/docs/interfaces/Filter.html +2 -0
  210. package/dist/docs/interfaces/GeneralFuntion.html +5 -0
  211. package/dist/docs/interfaces/GeneralItem.html +6 -0
  212. package/dist/docs/interfaces/HighlightTerm.html +2 -0
  213. package/dist/docs/interfaces/Incrementable.html +10 -0
  214. package/dist/docs/interfaces/InternalKey.html +4 -0
  215. package/dist/docs/interfaces/InternalModel.html +13 -0
  216. package/dist/docs/interfaces/LambdaHandlerService.html +20 -0
  217. package/dist/docs/interfaces/LemonEngine.html +29 -0
  218. package/dist/docs/interfaces/MetricPostBody.html +6 -0
  219. package/dist/docs/interfaces/ModelSynchronizer.html +8 -0
  220. package/dist/docs/interfaces/NextContext.html +29 -0
  221. package/dist/docs/interfaces/NextIdentity.html +28 -0
  222. package/dist/docs/interfaces/NextIdentityAccess.html +37 -0
  223. package/dist/docs/interfaces/NextIdentityCognito.html +46 -0
  224. package/dist/docs/interfaces/NextIdentityJwt.html +36 -0
  225. package/dist/docs/interfaces/NotificationBody.html +1 -0
  226. package/dist/docs/interfaces/NotificationParam.html +16 -0
  227. package/dist/docs/interfaces/ParrallelCallback.html +1 -0
  228. package/dist/docs/interfaces/ParrallelParam.html +10 -0
  229. package/dist/docs/interfaces/ParsedVersion.html +14 -0
  230. package/dist/docs/interfaces/ProtocolBody.html +2 -0
  231. package/dist/docs/interfaces/ProtocolParam.html +14 -0
  232. package/dist/docs/interfaces/ProtocolService.html +48 -0
  233. package/dist/docs/interfaces/ProtocolTransformer.html +13 -0
  234. package/dist/docs/interfaces/QueryResult.html +11 -0
  235. package/dist/docs/interfaces/RedisOptions.html +8 -0
  236. package/dist/docs/interfaces/RetryOptions.html +8 -0
  237. package/dist/docs/interfaces/Reversable.html +6 -0
  238. package/dist/docs/interfaces/SearchBody.html +10 -0
  239. package/dist/docs/interfaces/SearchProxyBody.html +13 -0
  240. package/dist/docs/interfaces/SearchQuery.html +19 -0
  241. package/dist/docs/interfaces/SearchResponse.html +5 -0
  242. package/dist/docs/interfaces/SearchResult.html +10 -0
  243. package/dist/docs/interfaces/SimpleSearchParam.html +16 -0
  244. package/dist/docs/interfaces/SimpleSet.html +7 -0
  245. package/dist/docs/interfaces/SlackAction.html +5 -0
  246. package/dist/docs/interfaces/SlackAttachment.html +24 -0
  247. package/dist/docs/interfaces/SlackPostBody.html +5 -0
  248. package/dist/docs/interfaces/StorageMakeable.html +10 -0
  249. package/dist/docs/interfaces/StorageModel.html +16 -0
  250. package/dist/docs/interfaces/StorageService.html +46 -0
  251. package/dist/docs/interfaces/Timeout.html +10 -0
  252. package/dist/docs/interfaces/Transformable.html +20 -0
  253. package/dist/docs/interfaces/Updatable.html +7 -0
  254. package/dist/docs/interfaces/View.html +21 -0
  255. package/dist/docs/interfaces/_web.HttpHeaderSet.html +5 -0
  256. package/dist/docs/interfaces/_web.HttpHeaderTool.html +26 -0
  257. package/dist/docs/interfaces/_web.VerifyTokenBody.html +4 -0
  258. package/dist/docs/interfaces/_web.VerifyTokenResult.html +6 -0
  259. package/dist/docs/interfaces/elasticsearch.ApiResponse.html +6 -0
  260. package/dist/docs/interfaces/elasticsearch.ClientExtendsCallbackOptions.html +4 -0
  261. package/dist/docs/interfaces/elasticsearch.ClientOptions.html +30 -0
  262. package/dist/docs/interfaces/elasticsearch.NodeOptions.html +7 -0
  263. package/dist/docs/interfaces/elasticsearch.RequestEvent.html +6 -0
  264. package/dist/docs/interfaces/elasticsearch.RequestParams.AsyncSearchDelete.html +8 -0
  265. package/dist/docs/interfaces/elasticsearch.RequestParams.AsyncSearchGet.html +11 -0
  266. package/dist/docs/interfaces/elasticsearch.RequestParams.AsyncSearchStatus.html +8 -0
  267. package/dist/docs/interfaces/elasticsearch.RequestParams.AsyncSearchSubmit.html +52 -0
  268. package/dist/docs/interfaces/elasticsearch.RequestParams.AutoscalingDeleteAutoscalingPolicy.html +8 -0
  269. package/dist/docs/interfaces/elasticsearch.RequestParams.AutoscalingGetAutoscalingCapacity.html +7 -0
  270. package/dist/docs/interfaces/elasticsearch.RequestParams.AutoscalingGetAutoscalingPolicy.html +8 -0
  271. package/dist/docs/interfaces/elasticsearch.RequestParams.AutoscalingPutAutoscalingPolicy.html +9 -0
  272. package/dist/docs/interfaces/elasticsearch.RequestParams.Bulk.html +21 -0
  273. package/dist/docs/interfaces/elasticsearch.RequestParams.CatAliases.html +15 -0
  274. package/dist/docs/interfaces/elasticsearch.RequestParams.CatAllocation.html +16 -0
  275. package/dist/docs/interfaces/elasticsearch.RequestParams.CatCount.html +13 -0
  276. package/dist/docs/interfaces/elasticsearch.RequestParams.CatFielddata.html +14 -0
  277. package/dist/docs/interfaces/elasticsearch.RequestParams.CatHealth.html +14 -0
  278. package/dist/docs/interfaces/elasticsearch.RequestParams.CatHelp.html +9 -0
  279. package/dist/docs/interfaces/elasticsearch.RequestParams.CatIndices.html +21 -0
  280. package/dist/docs/interfaces/elasticsearch.RequestParams.CatMaster.html +14 -0
  281. package/dist/docs/interfaces/elasticsearch.RequestParams.CatMlDataFrameAnalytics.html +16 -0
  282. package/dist/docs/interfaces/elasticsearch.RequestParams.CatMlDatafeeds.html +16 -0
  283. package/dist/docs/interfaces/elasticsearch.RequestParams.CatMlJobs.html +17 -0
  284. package/dist/docs/interfaces/elasticsearch.RequestParams.CatMlTrainedModels.html +18 -0
  285. package/dist/docs/interfaces/elasticsearch.RequestParams.CatNodeattrs.html +14 -0
  286. package/dist/docs/interfaces/elasticsearch.RequestParams.CatNodes.html +17 -0
  287. package/dist/docs/interfaces/elasticsearch.RequestParams.CatPendingTasks.html +15 -0
  288. package/dist/docs/interfaces/elasticsearch.RequestParams.CatPlugins.html +15 -0
  289. package/dist/docs/interfaces/elasticsearch.RequestParams.CatRecovery.html +17 -0
  290. package/dist/docs/interfaces/elasticsearch.RequestParams.CatRepositories.html +14 -0
  291. package/dist/docs/interfaces/elasticsearch.RequestParams.CatSegments.html +14 -0
  292. package/dist/docs/interfaces/elasticsearch.RequestParams.CatShards.html +17 -0
  293. package/dist/docs/interfaces/elasticsearch.RequestParams.CatSnapshots.html +16 -0
  294. package/dist/docs/interfaces/elasticsearch.RequestParams.CatTasks.html +17 -0
  295. package/dist/docs/interfaces/elasticsearch.RequestParams.CatTemplates.html +15 -0
  296. package/dist/docs/interfaces/elasticsearch.RequestParams.CatThreadPool.html +16 -0
  297. package/dist/docs/interfaces/elasticsearch.RequestParams.CatTransforms.html +17 -0
  298. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrDeleteAutoFollowPattern.html +8 -0
  299. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrFollow.html +10 -0
  300. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrFollowInfo.html +8 -0
  301. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrFollowStats.html +8 -0
  302. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrForgetFollower.html +9 -0
  303. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrGetAutoFollowPattern.html +8 -0
  304. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrPauseAutoFollowPattern.html +8 -0
  305. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrPauseFollow.html +8 -0
  306. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrPutAutoFollowPattern.html +9 -0
  307. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrResumeAutoFollowPattern.html +8 -0
  308. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrResumeFollow.html +9 -0
  309. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrStats.html +7 -0
  310. package/dist/docs/interfaces/elasticsearch.RequestParams.CcrUnfollow.html +8 -0
  311. package/dist/docs/interfaces/elasticsearch.RequestParams.ClearScroll.html +9 -0
  312. package/dist/docs/interfaces/elasticsearch.RequestParams.ClosePointInTime.html +8 -0
  313. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterAllocationExplain.html +10 -0
  314. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterDeleteComponentTemplate.html +10 -0
  315. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterDeleteVotingConfigExclusions.html +8 -0
  316. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterExistsComponentTemplate.html +10 -0
  317. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterGetComponentTemplate.html +10 -0
  318. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterGetSettings.html +11 -0
  319. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterHealth.html +19 -0
  320. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterPendingTasks.html +9 -0
  321. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterPostVotingConfigExclusions.html +10 -0
  322. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterPutComponentTemplate.html +12 -0
  323. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterPutSettings.html +11 -0
  324. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterRemoteInfo.html +7 -0
  325. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterReroute.html +14 -0
  326. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterState.html +17 -0
  327. package/dist/docs/interfaces/elasticsearch.RequestParams.ClusterStats.html +10 -0
  328. package/dist/docs/interfaces/elasticsearch.RequestParams.Count.html +24 -0
  329. package/dist/docs/interfaces/elasticsearch.RequestParams.Create.html +18 -0
  330. package/dist/docs/interfaces/elasticsearch.RequestParams.DanglingIndicesDeleteDanglingIndex.html +11 -0
  331. package/dist/docs/interfaces/elasticsearch.RequestParams.DanglingIndicesImportDanglingIndex.html +11 -0
  332. package/dist/docs/interfaces/elasticsearch.RequestParams.DanglingIndicesListDanglingIndices.html +7 -0
  333. package/dist/docs/interfaces/elasticsearch.RequestParams.Delete.html +18 -0
  334. package/dist/docs/interfaces/elasticsearch.RequestParams.DeleteByQuery.html +45 -0
  335. package/dist/docs/interfaces/elasticsearch.RequestParams.DeleteByQueryRethrottle.html +9 -0
  336. package/dist/docs/interfaces/elasticsearch.RequestParams.DeleteScript.html +10 -0
  337. package/dist/docs/interfaces/elasticsearch.RequestParams.EnrichDeletePolicy.html +8 -0
  338. package/dist/docs/interfaces/elasticsearch.RequestParams.EnrichExecutePolicy.html +9 -0
  339. package/dist/docs/interfaces/elasticsearch.RequestParams.EnrichGetPolicy.html +8 -0
  340. package/dist/docs/interfaces/elasticsearch.RequestParams.EnrichPutPolicy.html +9 -0
  341. package/dist/docs/interfaces/elasticsearch.RequestParams.EnrichStats.html +7 -0
  342. package/dist/docs/interfaces/elasticsearch.RequestParams.EqlDelete.html +8 -0
  343. package/dist/docs/interfaces/elasticsearch.RequestParams.EqlGet.html +10 -0
  344. package/dist/docs/interfaces/elasticsearch.RequestParams.EqlGetStatus.html +8 -0
  345. package/dist/docs/interfaces/elasticsearch.RequestParams.EqlSearch.html +12 -0
  346. package/dist/docs/interfaces/elasticsearch.RequestParams.Exists.html +22 -0
  347. package/dist/docs/interfaces/elasticsearch.RequestParams.ExistsSource.html +21 -0
  348. package/dist/docs/interfaces/elasticsearch.RequestParams.Explain.html +25 -0
  349. package/dist/docs/interfaces/elasticsearch.RequestParams.FeaturesGetFeatures.html +8 -0
  350. package/dist/docs/interfaces/elasticsearch.RequestParams.FieldCaps.html +14 -0
  351. package/dist/docs/interfaces/elasticsearch.RequestParams.Generic.html +7 -0
  352. package/dist/docs/interfaces/elasticsearch.RequestParams.Get.html +22 -0
  353. package/dist/docs/interfaces/elasticsearch.RequestParams.GetScript.html +9 -0
  354. package/dist/docs/interfaces/elasticsearch.RequestParams.GetScriptContext.html +7 -0
  355. package/dist/docs/interfaces/elasticsearch.RequestParams.GetScriptLanguages.html +7 -0
  356. package/dist/docs/interfaces/elasticsearch.RequestParams.GetSource.html +21 -0
  357. package/dist/docs/interfaces/elasticsearch.RequestParams.GraphExplore.html +12 -0
  358. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmDeleteLifecycle.html +8 -0
  359. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmExplainLifecycle.html +10 -0
  360. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmGetLifecycle.html +8 -0
  361. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmGetStatus.html +7 -0
  362. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmMoveToStep.html +9 -0
  363. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmPutLifecycle.html +9 -0
  364. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmRemovePolicy.html +8 -0
  365. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmRetry.html +8 -0
  366. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmStart.html +7 -0
  367. package/dist/docs/interfaces/elasticsearch.RequestParams.IlmStop.html +7 -0
  368. package/dist/docs/interfaces/elasticsearch.RequestParams.Index.html +22 -0
  369. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesAddBlock.html +14 -0
  370. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesAnalyze.html +9 -0
  371. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesClearCache.html +15 -0
  372. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesClone.html +13 -0
  373. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesClose.html +14 -0
  374. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesCreate.html +13 -0
  375. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesCreateDataStream.html +8 -0
  376. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesDataStreamsStats.html +8 -0
  377. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesDelete.html +13 -0
  378. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesDeleteAlias.html +11 -0
  379. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesDeleteDataStream.html +9 -0
  380. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesDeleteIndexTemplate.html +10 -0
  381. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesDeleteTemplate.html +10 -0
  382. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesExists.html +14 -0
  383. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesExistsAlias.html +13 -0
  384. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesExistsIndexTemplate.html +11 -0
  385. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesExistsTemplate.html +11 -0
  386. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesExistsType.html +13 -0
  387. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesFlush.html +13 -0
  388. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesFlushSynced.html +11 -0
  389. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesForcemerge.html +14 -0
  390. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesFreeze.html +14 -0
  391. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGet.html +16 -0
  392. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGetAlias.html +13 -0
  393. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGetDataStream.html +9 -0
  394. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGetFieldMapping.html +16 -0
  395. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGetIndexTemplate.html +11 -0
  396. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGetMapping.html +15 -0
  397. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGetSettings.html +16 -0
  398. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGetTemplate.html +12 -0
  399. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesGetUpgrade.html +11 -0
  400. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesMigrateToDataStream.html +8 -0
  401. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesOpen.html +14 -0
  402. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesPromoteDataStream.html +8 -0
  403. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesPutAlias.html +12 -0
  404. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesPutIndexTemplate.html +12 -0
  405. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesPutMapping.html +17 -0
  406. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesPutSettings.html +16 -0
  407. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesPutTemplate.html +13 -0
  408. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesRecovery.html +10 -0
  409. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesRefresh.html +11 -0
  410. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesReloadSearchAnalyzers.html +11 -0
  411. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesResolveIndex.html +9 -0
  412. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesRollover.html +15 -0
  413. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesSegments.html +12 -0
  414. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesShardStores.html +12 -0
  415. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesShrink.html +14 -0
  416. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesSimulateIndexTemplate.html +12 -0
  417. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesSimulateTemplate.html +12 -0
  418. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesSplit.html +14 -0
  419. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesStats.html +19 -0
  420. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesUnfreeze.html +14 -0
  421. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesUpdateAliases.html +10 -0
  422. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesUpgrade.html +13 -0
  423. package/dist/docs/interfaces/elasticsearch.RequestParams.IndicesValidateQuery.html +22 -0
  424. package/dist/docs/interfaces/elasticsearch.RequestParams.Info.html +7 -0
  425. package/dist/docs/interfaces/elasticsearch.RequestParams.IngestDeletePipeline.html +10 -0
  426. package/dist/docs/interfaces/elasticsearch.RequestParams.IngestGetPipeline.html +9 -0
  427. package/dist/docs/interfaces/elasticsearch.RequestParams.IngestProcessorGrok.html +7 -0
  428. package/dist/docs/interfaces/elasticsearch.RequestParams.IngestPutPipeline.html +11 -0
  429. package/dist/docs/interfaces/elasticsearch.RequestParams.IngestSimulate.html +10 -0
  430. package/dist/docs/interfaces/elasticsearch.RequestParams.LicenseDelete.html +7 -0
  431. package/dist/docs/interfaces/elasticsearch.RequestParams.LicenseGet.html +9 -0
  432. package/dist/docs/interfaces/elasticsearch.RequestParams.LicenseGetBasicStatus.html +7 -0
  433. package/dist/docs/interfaces/elasticsearch.RequestParams.LicenseGetTrialStatus.html +7 -0
  434. package/dist/docs/interfaces/elasticsearch.RequestParams.LicensePost.html +9 -0
  435. package/dist/docs/interfaces/elasticsearch.RequestParams.LicensePostStartBasic.html +8 -0
  436. package/dist/docs/interfaces/elasticsearch.RequestParams.LicensePostStartTrial.html +9 -0
  437. package/dist/docs/interfaces/elasticsearch.RequestParams.LogstashDeletePipeline.html +8 -0
  438. package/dist/docs/interfaces/elasticsearch.RequestParams.LogstashGetPipeline.html +8 -0
  439. package/dist/docs/interfaces/elasticsearch.RequestParams.LogstashPutPipeline.html +9 -0
  440. package/dist/docs/interfaces/elasticsearch.RequestParams.Mget.html +20 -0
  441. package/dist/docs/interfaces/elasticsearch.RequestParams.MigrationDeprecations.html +8 -0
  442. package/dist/docs/interfaces/elasticsearch.RequestParams.MlCloseJob.html +13 -0
  443. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteCalendar.html +8 -0
  444. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteCalendarEvent.html +9 -0
  445. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteCalendarJob.html +9 -0
  446. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteDataFrameAnalytics.html +10 -0
  447. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteDatafeed.html +9 -0
  448. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteExpiredData.html +11 -0
  449. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteFilter.html +8 -0
  450. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteForecast.html +11 -0
  451. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteJob.html +10 -0
  452. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteModelSnapshot.html +9 -0
  453. package/dist/docs/interfaces/elasticsearch.RequestParams.MlDeleteTrainedModel.html +8 -0
  454. package/dist/docs/interfaces/elasticsearch.RequestParams.MlEstimateModelMemory.html +8 -0
  455. package/dist/docs/interfaces/elasticsearch.RequestParams.MlEvaluateDataFrame.html +8 -0
  456. package/dist/docs/interfaces/elasticsearch.RequestParams.MlExplainDataFrameAnalytics.html +9 -0
  457. package/dist/docs/interfaces/elasticsearch.RequestParams.MlFlushJob.html +14 -0
  458. package/dist/docs/interfaces/elasticsearch.RequestParams.MlForecast.html +11 -0
  459. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetBuckets.html +19 -0
  460. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetCalendarEvents.html +13 -0
  461. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetCalendars.html +11 -0
  462. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetCategories.html +13 -0
  463. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetDataFrameAnalytics.html +12 -0
  464. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetDataFrameAnalyticsStats.html +12 -0
  465. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetDatafeedStats.html +10 -0
  466. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetDatafeeds.html +11 -0
  467. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetFilters.html +10 -0
  468. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetInfluencers.html +17 -0
  469. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetJobStats.html +10 -0
  470. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetJobs.html +11 -0
  471. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetModelSnapshots.html +16 -0
  472. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetOverallBuckets.html +17 -0
  473. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetRecords.html +17 -0
  474. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetTrainedModels.html +16 -0
  475. package/dist/docs/interfaces/elasticsearch.RequestParams.MlGetTrainedModelsStats.html +11 -0
  476. package/dist/docs/interfaces/elasticsearch.RequestParams.MlInfo.html +7 -0
  477. package/dist/docs/interfaces/elasticsearch.RequestParams.MlOpenJob.html +8 -0
  478. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPostCalendarEvents.html +9 -0
  479. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPostData.html +11 -0
  480. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPreviewDatafeed.html +8 -0
  481. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPutCalendar.html +9 -0
  482. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPutCalendarJob.html +9 -0
  483. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPutDataFrameAnalytics.html +9 -0
  484. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPutDatafeed.html +13 -0
  485. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPutFilter.html +9 -0
  486. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPutJob.html +9 -0
  487. package/dist/docs/interfaces/elasticsearch.RequestParams.MlPutTrainedModel.html +9 -0
  488. package/dist/docs/interfaces/elasticsearch.RequestParams.MlRevertModelSnapshot.html +11 -0
  489. package/dist/docs/interfaces/elasticsearch.RequestParams.MlSetUpgradeMode.html +9 -0
  490. package/dist/docs/interfaces/elasticsearch.RequestParams.MlStartDataFrameAnalytics.html +10 -0
  491. package/dist/docs/interfaces/elasticsearch.RequestParams.MlStartDatafeed.html +12 -0
  492. package/dist/docs/interfaces/elasticsearch.RequestParams.MlStopDataFrameAnalytics.html +12 -0
  493. package/dist/docs/interfaces/elasticsearch.RequestParams.MlStopDatafeed.html +13 -0
  494. package/dist/docs/interfaces/elasticsearch.RequestParams.MlUpdateDataFrameAnalytics.html +9 -0
  495. package/dist/docs/interfaces/elasticsearch.RequestParams.MlUpdateDatafeed.html +13 -0
  496. package/dist/docs/interfaces/elasticsearch.RequestParams.MlUpdateFilter.html +9 -0
  497. package/dist/docs/interfaces/elasticsearch.RequestParams.MlUpdateJob.html +9 -0
  498. package/dist/docs/interfaces/elasticsearch.RequestParams.MlUpdateModelSnapshot.html +10 -0
  499. package/dist/docs/interfaces/elasticsearch.RequestParams.MlUpgradeJobSnapshot.html +11 -0
  500. package/dist/docs/interfaces/elasticsearch.RequestParams.MlValidate.html +8 -0
  501. package/dist/docs/interfaces/elasticsearch.RequestParams.MlValidateDetector.html +8 -0
  502. package/dist/docs/interfaces/elasticsearch.RequestParams.MonitoringBulk.html +12 -0
  503. package/dist/docs/interfaces/elasticsearch.RequestParams.Msearch.html +17 -0
  504. package/dist/docs/interfaces/elasticsearch.RequestParams.MsearchTemplate.html +15 -0
  505. package/dist/docs/interfaces/elasticsearch.RequestParams.Mtermvectors.html +22 -0
  506. package/dist/docs/interfaces/elasticsearch.RequestParams.NodesHotThreads.html +14 -0
  507. package/dist/docs/interfaces/elasticsearch.RequestParams.NodesInfo.html +11 -0
  508. package/dist/docs/interfaces/elasticsearch.RequestParams.NodesReloadSecureSettings.html +10 -0
  509. package/dist/docs/interfaces/elasticsearch.RequestParams.NodesStats.html +18 -0
  510. package/dist/docs/interfaces/elasticsearch.RequestParams.NodesUsage.html +10 -0
  511. package/dist/docs/interfaces/elasticsearch.RequestParams.OpenPointInTime.html +13 -0
  512. package/dist/docs/interfaces/elasticsearch.RequestParams.Ping.html +7 -0
  513. package/dist/docs/interfaces/elasticsearch.RequestParams.PutScript.html +12 -0
  514. package/dist/docs/interfaces/elasticsearch.RequestParams.RankEval.html +13 -0
  515. package/dist/docs/interfaces/elasticsearch.RequestParams.Reindex.html +16 -0
  516. package/dist/docs/interfaces/elasticsearch.RequestParams.ReindexRethrottle.html +9 -0
  517. package/dist/docs/interfaces/elasticsearch.RequestParams.RenderSearchTemplate.html +9 -0
  518. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupDeleteJob.html +8 -0
  519. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupGetJobs.html +8 -0
  520. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupGetRollupCaps.html +8 -0
  521. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupGetRollupIndexCaps.html +8 -0
  522. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupPutJob.html +9 -0
  523. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupRollup.html +10 -0
  524. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupRollupSearch.html +12 -0
  525. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupStartJob.html +8 -0
  526. package/dist/docs/interfaces/elasticsearch.RequestParams.RollupStopJob.html +10 -0
  527. package/dist/docs/interfaces/elasticsearch.RequestParams.ScriptsPainlessExecute.html +8 -0
  528. package/dist/docs/interfaces/elasticsearch.RequestParams.Scroll.html +11 -0
  529. package/dist/docs/interfaces/elasticsearch.RequestParams.Search.html +55 -0
  530. package/dist/docs/interfaces/elasticsearch.RequestParams.SearchShards.html +14 -0
  531. package/dist/docs/interfaces/elasticsearch.RequestParams.SearchTemplate.html +23 -0
  532. package/dist/docs/interfaces/elasticsearch.RequestParams.SearchableSnapshotsClearCache.html +11 -0
  533. package/dist/docs/interfaces/elasticsearch.RequestParams.SearchableSnapshotsMount.html +13 -0
  534. package/dist/docs/interfaces/elasticsearch.RequestParams.SearchableSnapshotsRepositoryStats.html +8 -0
  535. package/dist/docs/interfaces/elasticsearch.RequestParams.SearchableSnapshotsStats.html +9 -0
  536. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityAuthenticate.html +7 -0
  537. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityChangePassword.html +10 -0
  538. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityClearApiKeyCache.html +8 -0
  539. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityClearCachedPrivileges.html +8 -0
  540. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityClearCachedRealms.html +9 -0
  541. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityClearCachedRoles.html +8 -0
  542. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityCreateApiKey.html +9 -0
  543. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityDeletePrivileges.html +10 -0
  544. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityDeleteRole.html +9 -0
  545. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityDeleteRoleMapping.html +9 -0
  546. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityDeleteUser.html +9 -0
  547. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityDisableUser.html +9 -0
  548. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityEnableUser.html +9 -0
  549. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGetApiKey.html +12 -0
  550. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGetBuiltinPrivileges.html +7 -0
  551. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGetPrivileges.html +9 -0
  552. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGetRole.html +8 -0
  553. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGetRoleMapping.html +8 -0
  554. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGetToken.html +8 -0
  555. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGetUser.html +8 -0
  556. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGetUserPrivileges.html +7 -0
  557. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityGrantApiKey.html +9 -0
  558. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityHasPrivileges.html +9 -0
  559. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityInvalidateApiKey.html +8 -0
  560. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityInvalidateToken.html +8 -0
  561. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityPutPrivileges.html +9 -0
  562. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityPutRole.html +10 -0
  563. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityPutRoleMapping.html +10 -0
  564. package/dist/docs/interfaces/elasticsearch.RequestParams.SecurityPutUser.html +10 -0
  565. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmDeleteLifecycle.html +8 -0
  566. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmExecuteLifecycle.html +8 -0
  567. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmExecuteRetention.html +7 -0
  568. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmGetLifecycle.html +8 -0
  569. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmGetStats.html +7 -0
  570. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmGetStatus.html +7 -0
  571. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmPutLifecycle.html +9 -0
  572. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmStart.html +7 -0
  573. package/dist/docs/interfaces/elasticsearch.RequestParams.SlmStop.html +7 -0
  574. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotCleanupRepository.html +10 -0
  575. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotClone.html +12 -0
  576. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotCreate.html +12 -0
  577. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotCreateRepository.html +12 -0
  578. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotDelete.html +10 -0
  579. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotDeleteRepository.html +10 -0
  580. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotGet.html +12 -0
  581. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotGetRepository.html +10 -0
  582. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotRestore.html +12 -0
  583. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotStatus.html +11 -0
  584. package/dist/docs/interfaces/elasticsearch.RequestParams.SnapshotVerifyRepository.html +10 -0
  585. package/dist/docs/interfaces/elasticsearch.RequestParams.SqlClearCursor.html +8 -0
  586. package/dist/docs/interfaces/elasticsearch.RequestParams.SqlQuery.html +9 -0
  587. package/dist/docs/interfaces/elasticsearch.RequestParams.SqlTranslate.html +8 -0
  588. package/dist/docs/interfaces/elasticsearch.RequestParams.SslCertificates.html +7 -0
  589. package/dist/docs/interfaces/elasticsearch.RequestParams.TasksCancel.html +12 -0
  590. package/dist/docs/interfaces/elasticsearch.RequestParams.TasksGet.html +10 -0
  591. package/dist/docs/interfaces/elasticsearch.RequestParams.TasksList.html +14 -0
  592. package/dist/docs/interfaces/elasticsearch.RequestParams.Termvectors.html +22 -0
  593. package/dist/docs/interfaces/elasticsearch.RequestParams.TextStructureFindStructure.html +22 -0
  594. package/dist/docs/interfaces/elasticsearch.RequestParams.TransformDeleteTransform.html +9 -0
  595. package/dist/docs/interfaces/elasticsearch.RequestParams.TransformGetTransform.html +12 -0
  596. package/dist/docs/interfaces/elasticsearch.RequestParams.TransformGetTransformStats.html +11 -0
  597. package/dist/docs/interfaces/elasticsearch.RequestParams.TransformPreviewTransform.html +8 -0
  598. package/dist/docs/interfaces/elasticsearch.RequestParams.TransformPutTransform.html +10 -0
  599. package/dist/docs/interfaces/elasticsearch.RequestParams.TransformStartTransform.html +9 -0
  600. package/dist/docs/interfaces/elasticsearch.RequestParams.TransformStopTransform.html +13 -0
  601. package/dist/docs/interfaces/elasticsearch.RequestParams.TransformUpdateTransform.html +10 -0
  602. package/dist/docs/interfaces/elasticsearch.RequestParams.Update.html +25 -0
  603. package/dist/docs/interfaces/elasticsearch.RequestParams.UpdateByQuery.html +47 -0
  604. package/dist/docs/interfaces/elasticsearch.RequestParams.UpdateByQueryRethrottle.html +9 -0
  605. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherAckWatch.html +9 -0
  606. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherActivateWatch.html +8 -0
  607. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherDeactivateWatch.html +8 -0
  608. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherDeleteWatch.html +8 -0
  609. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherExecuteWatch.html +10 -0
  610. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherGetWatch.html +8 -0
  611. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherPutWatch.html +13 -0
  612. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherQueryWatches.html +8 -0
  613. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherStart.html +7 -0
  614. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherStats.html +9 -0
  615. package/dist/docs/interfaces/elasticsearch.RequestParams.WatcherStop.html +7 -0
  616. package/dist/docs/interfaces/elasticsearch.RequestParams.XpackInfo.html +9 -0
  617. package/dist/docs/interfaces/elasticsearch.RequestParams.XpackUsage.html +8 -0
  618. package/dist/docs/interfaces/elasticsearch.ResurrectEvent.html +6 -0
  619. package/dist/docs/media/2019-11-26-23-43-47.png +0 -0
  620. package/dist/docs/media/CODE_OF_CONDUCT.md +76 -0
  621. package/dist/docs/media/HOW_TO_UPGRADE_V4.md +185 -0
  622. package/dist/docs/media/LICENSE +21 -0
  623. package/dist/docs/media/lemon-core-ms-arch.png +0 -0
  624. package/dist/docs/media/lemon-protocol-flow.png +0 -0
  625. package/dist/docs/modules/_sns.html +1 -0
  626. package/dist/docs/modules/_sqs.html +1 -0
  627. package/dist/docs/modules/_web.html +1 -0
  628. package/dist/docs/modules/_wss.html +1 -0
  629. package/dist/docs/modules/elasticsearch.RequestParams.html +1 -0
  630. package/dist/docs/modules/elasticsearch.errors.html +1 -0
  631. package/dist/docs/modules/elasticsearch.html +1 -0
  632. package/dist/docs/modules/lib.html +1 -0
  633. package/dist/docs/modules/tools.html +1 -0
  634. package/dist/docs/modules.html +1 -0
  635. package/dist/docs/types/ALBEvent.html +1 -0
  636. package/dist/docs/types/ALBHandler.html +1 -0
  637. package/dist/docs/types/ALBResult.html +1 -0
  638. package/dist/docs/types/APIHttpMethod.html +2 -0
  639. package/dist/docs/types/CacheKey.html +2 -0
  640. package/dist/docs/types/CognitoHandler.html +1 -0
  641. package/dist/docs/types/ConfigService.html +1 -0
  642. package/dist/docs/types/Context.html +1 -0
  643. package/dist/docs/types/CoreModelFilter.html +5 -0
  644. package/dist/docs/types/CronHandler.html +1 -0
  645. package/dist/docs/types/CronNextHandler.html +1 -0
  646. package/dist/docs/types/DDSEvent.html +1 -0
  647. package/dist/docs/types/DynamoScanFilter.html +1 -0
  648. package/dist/docs/types/DynamoStreamEvent.html +1 -0
  649. package/dist/docs/types/DynamoStreamHandler.html +1 -0
  650. package/dist/docs/types/DynamoStreamNextHandler.html +1 -0
  651. package/dist/docs/types/EngineLogger.html +1 -0
  652. package/dist/docs/types/EngineType.html +2 -0
  653. package/dist/docs/types/FailedItem.html +2 -0
  654. package/dist/docs/types/HandlerType.html +1 -0
  655. package/dist/docs/types/KEY_TYPE.html +1 -0
  656. package/dist/docs/types/KeyValueMap.html +2 -0
  657. package/dist/docs/types/MyHandler.html +1 -0
  658. package/dist/docs/types/NextDecoder.html +2 -0
  659. package/dist/docs/types/NextHandler.html +6 -0
  660. package/dist/docs/types/NextMode.html +5 -0
  661. package/dist/docs/types/NotificationHandler.html +1 -0
  662. package/dist/docs/types/NotificationNextHandler.html +6 -0
  663. package/dist/docs/types/QueryTerm.html +6 -0
  664. package/dist/docs/types/SNSEvent.html +1 -0
  665. package/dist/docs/types/SNSHandler.html +1 -0
  666. package/dist/docs/types/SQSEvent.html +1 -0
  667. package/dist/docs/types/SQSHandler.html +1 -0
  668. package/dist/docs/types/STAGE.html +1 -0
  669. package/dist/docs/types/SearchType.html +1 -0
  670. package/dist/docs/types/SortTerm.html +6 -0
  671. package/dist/docs/types/WEBEvent.html +1 -0
  672. package/dist/docs/types/WEBHandler.html +1 -0
  673. package/dist/docs/types/WEBResult.html +1 -0
  674. package/dist/docs/types/WSSEvent.html +1 -0
  675. package/dist/docs/types/WSSHandler.html +1 -0
  676. package/dist/docs/types/WSSResult.html +1 -0
  677. package/dist/docs/types/elasticsearch.ApiError.html +1 -0
  678. package/dist/docs/variables/CORE_FIELDS.html +1 -0
  679. package/dist/docs/variables/DEFAULT_TIME_ZONE.html +1 -0
  680. package/dist/docs/variables/ENGINE_KEY_IN_SCOPE.html +2 -0
  681. package/dist/docs/variables/_ERROR.html +2 -0
  682. package/dist/docs/variables/_ES6.html +5 -0
  683. package/dist/docs/variables/_T.html +39 -0
  684. package/dist/docs/variables/_U.html +1 -0
  685. package/dist/docs/variables/_engine.html +1 -0
  686. package/dist/docs/variables/_err.html +1 -0
  687. package/dist/docs/variables/_hangul.html +1 -0
  688. package/dist/docs/variables/_inf.html +1 -0
  689. package/dist/docs/variables/_log.html +1 -0
  690. package/dist/docs/variables/_rand.html +7 -0
  691. package/dist/docs/variables/default.html +16 -0
  692. package/dist/docs/variables/do_parrallel.html +12 -0
  693. package/dist/docs/variables/elasticsearch.events.html +1 -0
  694. package/dist/docs/variables/my_parrallel.html +17 -0
  695. package/dist/engine/utilities.d.ts +3 -3
  696. package/dist/engine/utilities.js +11 -10
  697. package/dist/engine/utilities.js.map +1 -1
  698. package/dist/exec-cli.d.ts +2 -0
  699. package/dist/exec-cli.js +211 -0
  700. package/dist/exec-cli.js.map +1 -0
  701. package/dist/extended/abstract-service.js +2 -2
  702. package/dist/extended/abstract-service.js.map +1 -1
  703. package/dist/helpers/helpers.d.ts +65 -10
  704. package/dist/helpers/helpers.js +155 -17
  705. package/dist/helpers/helpers.js.map +1 -1
  706. package/dist/helpers/index.d.ts +1 -0
  707. package/dist/helpers/index.js +1 -0
  708. package/dist/helpers/index.js.map +1 -1
  709. package/dist/helpers/types.d.ts +217 -0
  710. package/dist/helpers/types.js +3 -0
  711. package/dist/helpers/types.js.map +1 -0
  712. package/dist/lib/dynamo/expressions.d.ts +14 -0
  713. package/dist/lib/dynamo/expressions.js +212 -0
  714. package/dist/lib/dynamo/expressions.js.map +1 -0
  715. package/dist/lib/dynamo/query.d.ts +43 -0
  716. package/dist/lib/dynamo/query.js +246 -0
  717. package/dist/lib/dynamo/query.js.map +1 -0
  718. package/dist/lib/dynamo/scan.d.ts +33 -0
  719. package/dist/lib/dynamo/scan.js +172 -0
  720. package/dist/lib/dynamo/scan.js.map +1 -0
  721. package/dist/lib/dynamo/serializer.d.ts +12 -0
  722. package/dist/lib/dynamo/serializer.js +243 -0
  723. package/dist/lib/dynamo/serializer.js.map +1 -0
  724. package/dist/lib/dynamo/utils.d.ts +15 -0
  725. package/dist/lib/dynamo/utils.js +129 -0
  726. package/dist/lib/dynamo/utils.js.map +1 -0
  727. package/dist/tools/shared.d.ts +35 -0
  728. package/dist/tools/shared.js +134 -0
  729. package/dist/tools/shared.js.map +1 -0
  730. package/package.json +1 -1
@@ -0,0 +1,20 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AWSModule | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">lemon-core</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">AWSModule</a></li></ul><h1>Class AWSModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>class: <code>EngineModule</code></p>
2
+ <ul>
3
+ <li>override this to register as module.</li>
4
+ </ul>
5
+ </div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/EngineModule.html" class="tsd-signature-type tsd-kind-interface">EngineModule</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/index.ts#L23">src/cores/aws/index.ts:23</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-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
6
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#kms" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kms</span></a>
7
+ <a href="#s3" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>s3</span></a>
8
+ <a href="#sns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sns</span></a>
9
+ <a href="#sqs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sqs</span></a>
10
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#getmodulename" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Module<wbr/>Name</span></a>
11
+ <a href="#initmodule" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Module</span></a>
12
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorawsmodule"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">AWSModule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">engine</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/LemonEngine.html" class="tsd-signature-type tsd-kind-interface">LemonEngine</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">AWSModule</a><a href="#constructorawsmodule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">engine</span>: <a href="../interfaces/LemonEngine.html" class="tsd-signature-type tsd-kind-interface">LemonEngine</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">AWSModule</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/index.ts#L25">src/cores/aws/index.ts:25</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="kms"><span>kms</span><a href="#kms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">kms</span><span class="tsd-signature-symbol">:</span> <a href="AWSKMSService.html" class="tsd-signature-type tsd-kind-class">AWSKMSService</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/index.ts#L31">src/cores/aws/index.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="s3"><span>s3</span><a href="#s3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">s3</span><span class="tsd-signature-symbol">:</span> <a href="AWSS3Service.html" class="tsd-signature-type tsd-kind-class">AWSS3Service</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/index.ts#L34">src/cores/aws/index.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sns"><span>sns</span><a href="#sns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sns</span><span class="tsd-signature-symbol">:</span> <a href="AWSSNSService.html" class="tsd-signature-type tsd-kind-class">AWSSNSService</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/index.ts#L32">src/cores/aws/index.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sqs"><span>sqs</span><a href="#sqs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sqs</span><span class="tsd-signature-symbol">:</span> <a href="AWSSQSService.html" class="tsd-signature-type tsd-kind-class">AWSSQSService</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/index.ts#L33">src/cores/aws/index.ts:33</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmodulename"><span>get<wbr/>Module<wbr/>Name</span><a href="#getmodulename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getmodulename-1"><span class="tsd-kind-call-signature">getModuleName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getmodulename-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>returns module name</p>
13
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/EngineModule.html">EngineModule</a>.<a href="../interfaces/EngineModule.html#getmodulename">getModuleName</a></p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/index.ts#L36">src/cores/aws/index.ts:36</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="initmodule"><span>init<wbr/>Module</span><a href="#initmodule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="initmodule-1"><span class="tsd-kind-call-signature">initModule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><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">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#initmodule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>initialize module with async</p>
14
+ <ul>
15
+ <li>use <code>level</code> to determine the required level if level === undefined.</li>
16
+ <li>start init if level is matched.</li>
17
+ </ul>
18
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the level of init. (starts 0)</p>
19
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the required level if !level.</p>
20
+ <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/EngineModule.html">EngineModule</a>.<a href="../interfaces/EngineModule.html#initmodule">initModule</a></p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/index.ts#L37">src/cores/aws/index.ts:37</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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-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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#kms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kms</span></a><a href="#s3"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>s3</span></a><a href="#sns"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sns</span></a><a href="#sqs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sqs</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getmodulename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Module<wbr/>Name</span></a><a href="#initmodule"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Module</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">lemon-core</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -0,0 +1,45 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AWSS3Service | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">lemon-core</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">AWSS3Service</a></li></ul><h1>Class AWSS3Service</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>main service implement.</p>
2
+ </div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">CoreS3Service</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L167">src/cores/aws/aws-s3-service.ts:167</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-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#def_s3_bucket" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEF_<wbr/>S3_<wbr/>BUCKET</span></a>
4
+ <a href="#env_s3_name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ENV_<wbr/>S3_<wbr/>NAME</span></a>
5
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#bucket" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bucket</span></a>
6
+ <a href="#deleteobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Object</span></a>
7
+ <a href="#getdecodedobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Decoded<wbr/>Object</span></a>
8
+ <a href="#getobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Object</span></a>
9
+ <a href="#getobjecttagging" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Object<wbr/>Tagging</span></a>
10
+ <a href="#headobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>head<wbr/>Object</span></a>
11
+ <a href="#hello" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hello</span></a>
12
+ <a href="#instance" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>instance</span></a>
13
+ <a href="#listobjects" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Objects</span></a>
14
+ <a href="#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>name</span></a>
15
+ <a href="#putobject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Object</span></a>
16
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorawss3service"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">AWSS3Service</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">AWSS3Service</a><a href="#constructorawss3service" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">AWSS3Service</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="def_s3_bucket"><code class="tsd-tag">Static</code><span>DEF_<wbr/>S3_<wbr/>BUCKET</span><a href="#def_s3_bucket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEF_S3_BUCKET</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;lemon-hello-www&#39;</span></div><div class="tsd-comment tsd-typography"><p>default <code>bucket</code> name</p>
17
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L175">src/cores/aws/aws-s3-service.ts:175</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="env_s3_name"><code class="tsd-tag">Static</code><span>ENV_<wbr/>S3_<wbr/>NAME</span><a href="#env_s3_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ENV_S3_NAME</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;MY_S3_BUCKET&#39;</span></div><div class="tsd-comment tsd-typography"><p>environ name to use <code>bucket</code></p>
18
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L171">src/cores/aws/aws-s3-service.ts:171</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="bucket"><span>bucket</span><a href="#bucket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="bucket-1"><span class="tsd-kind-call-signature">bucket</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><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="#bucket-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get target endpoint by name.</p>
19
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of CoreS3Service.bucket</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L190">src/cores/aws/aws-s3-service.ts:190</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteobject"><span>delete<wbr/>Object</span><a href="#deleteobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deleteobject-1"><span class="tsd-kind-call-signature">deleteObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deleteobject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>delete object from bucket</p>
20
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of CoreS3Service.deleteObject</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L389">src/cores/aws/aws-s3-service.ts:389</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdecodedobject"><span>get<wbr/>Decoded<wbr/>Object</span><a href="#getdecodedobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getdecodedobject-1"><span class="tsd-kind-call-signature">getDecodedObject</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getdecodedobjectt">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getdecodedobjectt">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#getdecodedobject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>return decoded Object from bucket file.</p>
21
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getdecodedobjectt"><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">object</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>ex) 'hello-0001.json' , 'dist/hello-0001.json</p>
22
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getdecodedobjectt">T</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of CoreS3Service.getDecodedObject</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L337">src/cores/aws/aws-s3-service.ts:337</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getobject"><span>get<wbr/>Object</span><a href="#getobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getobject-1"><span class="tsd-kind-call-signature">getObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><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">&lt;</span><span class="tsd-signature-type">GetObjectResult</span><span class="tsd-signature-symbol">&gt;</span><a href="#getobject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get a file from S3 Bucket</p>
23
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">GetObjectResult</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of CoreS3Service.getObject</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L309">src/cores/aws/aws-s3-service.ts:309</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getobjecttagging"><span>get<wbr/>Object<wbr/>Tagging</span><a href="#getobjecttagging" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getobjecttagging-1"><span class="tsd-kind-call-signature">getObjectTagging</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><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">&lt;</span><span class="tsd-signature-type">TagSet</span><span class="tsd-signature-symbol">&gt;</span><a href="#getobjecttagging-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get tag-set of object</p>
24
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TagSet</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of CoreS3Service.getObjectTagging</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L363">src/cores/aws/aws-s3-service.ts:363</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="headobject"><span>head<wbr/>Object</span><a href="#headobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="headobject-1"><span class="tsd-kind-call-signature">headObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><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">&lt;</span><span class="tsd-signature-type">HeadObjectResult</span><span class="tsd-signature-symbol">&gt;</span><a href="#headobject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>retrieve metadata without returning the object</p>
25
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HeadObjectResult</span><span class="tsd-signature-symbol">&gt;</span></h4><p>metadata object / null if not exists</p>
26
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L206">src/cores/aws/aws-s3-service.ts:206</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hello"><span>hello</span><a href="#hello" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="hello-1"><span class="tsd-kind-call-signature">hello</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#hello-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>hello</p>
27
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of CoreS3Service.hello</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L185">src/cores/aws/aws-s3-service.ts:185</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="instance"><code class="tsd-tag">Protected</code><span>instance</span><a href="#instance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class=""><div class="tsd-signature tsd-anchor-link" id="instance-1"><span class="tsd-kind-call-signature">instance</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">S3Client</span><a href="#instance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get S3Client instance</p>
28
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">S3Client</span></h4><p>S3Client</p>
29
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L196">src/cores/aws/aws-s3-service.ts:196</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="listobjects"><span>list<wbr/>Objects</span><a href="#listobjects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="listobjects-1"><span class="tsd-kind-call-signature">listObjects</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">delimiter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">nextToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">throwable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">unlimited</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ListObjectResult</span><span class="tsd-signature-symbol">&gt;</span><a href="#listobjects-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>list objects in bucket</p>
30
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">delimiter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">nextToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">throwable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">unlimited</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">delimiter</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>use to group keys</p>
31
+ </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>maximum number of keys returned in single request (default 10, max 1000)</p>
32
+ </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">nextToken</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>same as NextContinuationToken</p>
33
+ </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>keys that begin with the specified prefix.</p>
34
+ </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">throwable</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>(optional) flag to throw error if error, or see <code>.error</code> in result</p>
35
+ </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">unlimited</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>flag to read all keys (each request contains <code>limit</code>)</p>
36
+ </div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ListObjectResult</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L409">src/cores/aws/aws-s3-service.ts:409</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="name-1"><span class="tsd-kind-call-signature">name</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#name-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get name of this</p>
37
+ </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/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L180">src/cores/aws/aws-s3-service.ts:180</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="putobject"><span>put<wbr/>Object</span><a href="#putobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="putobject-1"><span class="tsd-kind-call-signature">putObject</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">content</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Metadata</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">tags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TagSet</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PutObjectResult</span><span class="tsd-signature-symbol">&gt;</span><a href="#putobject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>upload a file to S3 Bucket</p>
38
+ <pre><code class="js"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">res</span><span class="hl-1"> = </span><span class="hl-2">$s3</span><span class="hl-1">.</span><span class="hl-8">putObject</span><span class="hl-1">(</span><span class="hl-6">JSON</span><span class="hl-1">.</span><span class="hl-8">stringify</span><span class="hl-1">({ </span><span class="hl-2">message</span><span class="hl-1"> }), </span><span class="hl-3">&#39;test.json&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">// response would be like</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">&quot;Bucket&quot;</span><span class="hl-1">: </span><span class="hl-3">&quot;lemon-hello-www&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">&quot;ETag&quot;</span><span class="hl-1">: </span><span class="hl-3">&quot;5e206.....8bd4c&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">&quot;Key&quot;</span><span class="hl-1">: </span><span class="hl-3">&quot;test.json&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-3">&quot;Location&quot;</span><span class="hl-1">: </span><span class="hl-3">&quot;https://lemon-hello-www.s3.ap-northeast-2.amazonaws.com/test.json&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">}</span>
39
+ </code><button type="button">Copy</button></pre>
40
+
41
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">content</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>content body</p>
42
+ </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>(optional) S3 key to put</p>
43
+ </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">metadata</span>: <span class="tsd-signature-type">Metadata</span></span><div class="tsd-comment tsd-typography"><p>(optional) metadata to store</p>
44
+ </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">tags</span>: <span class="tsd-signature-type">TagSet</span></span><div class="tsd-comment tsd-typography"><p>(optional) tag set</p>
45
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PutObjectResult</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of CoreS3Service.putObject</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-s3-service.ts#L261">src/cores/aws/aws-s3-service.ts:261</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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-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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#def_s3_bucket"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEF_<wbr/>S3_<wbr/>BUCKET</span></a><a href="#env_s3_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ENV_<wbr/>S3_<wbr/>NAME</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#bucket"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bucket</span></a><a href="#deleteobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Object</span></a><a href="#getdecodedobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Decoded<wbr/>Object</span></a><a href="#getobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Object</span></a><a href="#getobjecttagging"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Object<wbr/>Tagging</span></a><a href="#headobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>head<wbr/>Object</span></a><a href="#hello"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hello</span></a><a href="#instance" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>instance</span></a><a href="#listobjects"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Objects</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>name</span></a><a href="#putobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Object</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">lemon-core</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -0,0 +1,31 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AWSSNSService | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">lemon-core</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">AWSSNSService</a></li></ul><h1>Class AWSSNSService</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>main service instance.</p>
2
+ </div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/CoreSnsService.html" class="tsd-signature-type tsd-kind-interface">CoreSnsService</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L42">src/cores/aws/aws-sns-service.ts:42</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-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
3
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#def_sns_endpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEF_<wbr/>SNS_<wbr/>ENDPOINT</span></a>
4
+ <a href="#env_sns_endpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ENV_<wbr/>SNS_<wbr/>ENDPOINT</span></a>
5
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#accountid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>account<wbr/>ID</span></a>
6
+ <a href="#aspayload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Payload</span></a>
7
+ <a href="#endpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>endpoint</span></a>
8
+ <a href="#hello" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hello</span></a>
9
+ <a href="#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>name</span></a>
10
+ <a href="#publish" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>publish</span></a>
11
+ <a href="#reporterror" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>report<wbr/>Error</span></a>
12
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorawssnsservice"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">AWSSNSService</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arn</span><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="" class="tsd-signature-type tsd-kind-class">AWSSNSService</a><a href="#constructorawssnsservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">arn</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">AWSSNSService</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L51">src/cores/aws/aws-sns-service.ts:51</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="def_sns_endpoint"><code class="tsd-tag">Static</code><span>DEF_<wbr/>SNS_<wbr/>ENDPOINT</span><a href="#def_sns_endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">DEF_SNS_ENDPOINT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;lemon-hello-sns&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L48">src/cores/aws/aws-sns-service.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="env_sns_endpoint"><code class="tsd-tag">Static</code><span>ENV_<wbr/>SNS_<wbr/>ENDPOINT</span><a href="#env_sns_endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ENV_SNS_ENDPOINT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;MY_SNS_ENDPOINT&#39;</span></div><div class="tsd-comment tsd-typography"><p>environ name of SNS KEY</p>
13
+ <ul>
14
+ <li>for self messaging.</li>
15
+ </ul>
16
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L47">src/cores/aws/aws-sns-service.ts:47</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="accountid"><span>account<wbr/>ID</span><a href="#accountid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="accountid-1"><span class="tsd-kind-call-signature">accountID</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">engine</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/LemonEngine.html" class="tsd-signature-type tsd-kind-interface">LemonEngine</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">$cfg</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/AwsConfigParams.html" class="tsd-signature-type tsd-kind-interface">AwsConfigParams</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#accountid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get current aws account-id.</p>
17
+ <p>refer: <code>https://stackoverflow.com/questions/35563270/finding-my-aws-account-id-using-javascript</code></p>
18
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">engine</span>: <a href="../interfaces/LemonEngine.html" class="tsd-signature-type tsd-kind-interface">LemonEngine</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">$cfg</span>: <a href="../interfaces/AwsConfigParams.html" class="tsd-signature-type tsd-kind-interface">AwsConfigParams</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L101">src/cores/aws/aws-sns-service.ts:101</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="aspayload"><span>as<wbr/>Payload</span><a href="#aspayload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="aspayload-1"><span class="tsd-kind-call-signature">asPayload</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">e</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorPayload</span><a href="#aspayload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>convert Error to payload.</p>
19
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">e</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ErrorPayload</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L195">src/cores/aws/aws-sns-service.ts:195</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="endpoint"><span>endpoint</span><a href="#endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="endpoint-1"><span class="tsd-kind-call-signature">endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#endpoint-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get target endpoint by name.</p>
20
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L68">src/cores/aws/aws-sns-service.ts:68</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hello"><span>hello</span><a href="#hello" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="hello-1"><span class="tsd-kind-call-signature">hello</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#hello-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>hello</p>
21
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/CoreSnsService.html">CoreSnsService</a>.<a href="../interfaces/CoreSnsService.html#hello">hello</a></p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L63">src/cores/aws/aws-sns-service.ts:63</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="name-1"><span class="tsd-kind-call-signature">name</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#name-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get name of this</p>
22
+ </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/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L58">src/cores/aws/aws-sns-service.ts:58</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publish"><span>publish</span><a href="#publish" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="publish-1"><span class="tsd-kind-call-signature">publish</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">subject</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#publish-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>publish message</p>
23
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">subject</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>message-id</p>
24
+ <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/CoreSnsService.html">CoreSnsService</a>.<a href="../interfaces/CoreSnsService.html#publish">publish</a></p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L138">src/cores/aws/aws-sns-service.ts:138</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="reporterror"><span>report<wbr/>Error</span><a href="#reporterror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="reporterror-1"><span class="tsd-kind-call-signature">reportError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">e</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">target</span><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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#reporterror-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>report error via SNS with subject 'error'</p>
25
+ <ul>
26
+ <li>default to <code>lemon-hello-sns</code> or using <code>env[REPORT_ERROR_ARN]</code></li>
27
+ </ul>
28
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">e</span>: <span class="tsd-signature-type">Error</span></span><div class="tsd-comment tsd-typography"><p>Error instance</p>
29
+ </div></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>simple text message or object to override.</p>
30
+ </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>(optional) target SNS arn (default is <code>REPORT_ERROR_ARN</code>)</p>
31
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/CoreSnsService.html">CoreSnsService</a>.<a href="../interfaces/CoreSnsService.html#reporterror">reportError</a></p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sns-service.ts#L177">src/cores/aws/aws-sns-service.ts:177</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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-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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#def_sns_endpoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>DEF_<wbr/>SNS_<wbr/>ENDPOINT</span></a><a href="#env_sns_endpoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ENV_<wbr/>SNS_<wbr/>ENDPOINT</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#accountid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>account<wbr/>ID</span></a><a href="#aspayload"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>as<wbr/>Payload</span></a><a href="#endpoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>endpoint</span></a><a href="#hello"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hello</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>name</span></a><a href="#publish"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>publish</span></a><a href="#reporterror"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>report<wbr/>Error</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">lemon-core</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -0,0 +1,27 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AWSSQSService | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">lemon-core</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">AWSSQSService</a></li></ul><h1>Class AWSSQSService</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>class: AWSSQSService</p>
2
+ <ul>
3
+ <li>support of AWS <code>SQS</code> Service</li>
4
+ </ul>
5
+ </div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">SQSService</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L67">src/cores/aws/aws-sqs-service.ts:67</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-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
6
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#_endpoint" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>endpoint</span></a>
7
+ <a href="#_region" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>region</span></a>
8
+ <a href="#sqs_endpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>SQS_<wbr/>ENDPOINT</span></a>
9
+ <a href="#sqs_region" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>SQS_<wbr/>REGION</span></a>
10
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#deletemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Message</span></a>
11
+ <a href="#endpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>endpoint</span></a>
12
+ <a href="#hello" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hello</span></a>
13
+ <a href="#receivemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>receive<wbr/>Message</span></a>
14
+ <a href="#region" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>region</span></a>
15
+ <a href="#sendmessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message</span></a>
16
+ <a href="#statistics" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>statistics</span></a>
17
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorawssqsservice"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">AWSSQSService</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">endpoint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">region</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">profile</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">AWSSQSService</a><a href="#constructorawssqsservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>default constructor.</p>
18
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">region</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">profile</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">AWSSQSService</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L77">src/cores/aws/aws-sqs-service.ts:77</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_endpoint"><code class="tsd-tag">Protected</code><span>_<wbr/>endpoint</span><a href="#_endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_endpoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L72">src/cores/aws/aws-sqs-service.ts:72</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><h3 class="tsd-anchor-link" id="_region"><code class="tsd-tag">Protected</code><span>_<wbr/>region</span><a href="#_region" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">_region</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L71">src/cores/aws/aws-sqs-service.ts:71</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sqs_endpoint"><code class="tsd-tag">Static</code><span>SQS_<wbr/>ENDPOINT</span><a href="#sqs_endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">SQS_ENDPOINT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;MY_SQS_ENDPOINT&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L69">src/cores/aws/aws-sqs-service.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sqs_region"><code class="tsd-tag">Static</code><span>SQS_<wbr/>REGION</span><a href="#sqs_region" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">SQS_REGION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;MY_SQS_REGION&#39;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L68">src/cores/aws/aws-sqs-service.ts:68</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletemessage"><span>delete<wbr/>Message</span><a href="#deletemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deletemessage-1"><span class="tsd-kind-call-signature">deleteMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handle</span><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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deletemessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>delete message by id</p>
19
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handle</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>handle-id to delete.</p>
20
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of SQSService.deleteMessage</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L186">src/cores/aws/aws-sqs-service.ts:186</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="endpoint"><span>endpoint</span><a href="#endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="endpoint-1"><span class="tsd-kind-call-signature">endpoint</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#endpoint-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><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/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L90">src/cores/aws/aws-sqs-service.ts:90</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hello"><span>hello</span><a href="#hello" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="hello-1"><span class="tsd-kind-call-signature">hello</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#hello-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>hello</p>
21
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of SQSService.hello</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L97">src/cores/aws/aws-sqs-service.ts:97</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="receivemessage"><span>receive<wbr/>Message</span><a href="#receivemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="receivemessage-1"><span class="tsd-kind-call-signature">receiveMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><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">&lt;</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">list</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SqsMessage</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><a href="#receivemessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>receive message by size.</p>
22
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></span><div class="tsd-comment tsd-typography"><p>(default 1) size of message</p>
23
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">list</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SqsMessage</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of SQSService.receiveMessage</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L138">src/cores/aws/aws-sqs-service.ts:138</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="region"><span>region</span><a href="#region" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="region-1"><span class="tsd-kind-call-signature">region</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#region-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><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/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L87">src/cores/aws/aws-sqs-service.ts:87</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sendmessage"><span>send<wbr/>Message</span><a href="#sendmessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sendmessage-1"><span class="tsd-kind-call-signature">sendMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">attr</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SQSAttribute</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>send message into SQS.</p>
24
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>object data to be json.</p>
25
+ </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">attr</span>: <span class="tsd-signature-type">SQSAttribute</span></span><div class="tsd-comment tsd-typography"><p>attribute set.</p>
26
+ </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of SQSService.sendMessage</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L105">src/cores/aws/aws-sqs-service.ts:105</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="statistics"><span>statistics</span><a href="#statistics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="statistics-1"><span class="tsd-kind-call-signature">statistics</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">&lt;</span><span class="tsd-signature-type">SqsStatistics</span><span class="tsd-signature-symbol">&gt;</span><a href="#statistics-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>statistics for the given type.</p>
27
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SqsStatistics</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of SQSService.statistics</p><ul><li>Defined in <a href="https://github.com/lemoncloud-io/lemon-core/blob/763c6319e4b926dd24b1788a55c1b0de2e1f9626/src/cores/aws/aws-sqs-service.ts#L209">src/cores/aws/aws-sqs-service.ts:209</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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-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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#_endpoint" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>endpoint</span></a><a href="#_region" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>region</span></a><a href="#sqs_endpoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>SQS_<wbr/>ENDPOINT</span></a><a href="#sqs_region"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>SQS_<wbr/>REGION</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#deletemessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Message</span></a><a href="#endpoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>endpoint</span></a><a href="#hello"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hello</span></a><a href="#receivemessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>receive<wbr/>Message</span></a><a href="#region"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>region</span></a><a href="#sendmessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message</span></a><a href="#statistics"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>statistics</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">lemon-core</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>