Skip to content

Commit 8da18f6

Browse files
[fix]docs
1 parent 894497f commit 8da18f6

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

src/common/util/EncryptRequest.js

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ import {
99
import URI from 'urijs';
1010

1111
/**
12-
* @name EncryptRequest
13-
* @version 11.2.0
14-
* @namespace
15-
* @category BaseTypes Util
12+
* @class EncryptRequest
13+
* @category iServer Core
1614
* @classdesc 加密请求地址
17-
* @param {string} serverUrl - 服务地址。
15+
* @param {string} serverUrl - iServer 服务地址。如:http://127.0.0.1:8090/iserver。
16+
* @version 11.2.0
17+
* @usage
1818
*/
1919
export class EncryptRequest {
2020
constructor(serverUrl) {
@@ -144,10 +144,24 @@ export class EncryptRequest {
144144
/**
145145
* @function getServiceKey
146146
* @version 11.2.0
147-
* @category iServer
147+
* @category iServer Core
148148
* @description 获取矢量瓦片解密密钥
149-
* @param {string} serviceUrl - iserver服务地址,例如: 'http://127.0.0.1:8090/iserver/services/xxx'、 'http://127.0.0.1:8090/iserver/services/xxx/rest/maps' 、 'http://127.0.0.1:8090/iserver/services/xxx/restjsr/v1/vectortile'
150-
* @return {Promise} key - 矢量瓦片密钥
149+
* @param {string} serviceUrl - iServer 服务地址。例如:http://127.0.0.1:8090/iserver/services/xxx、http://127.0.0.1:8090/iserver/services/xxx/rest/maps、http://127.0.0.1:8090/iserver/services/xxx/restjsr/v1/vectortile。
150+
* @return {Promise} key - 矢量瓦片密钥。
151+
* @usage
152+
* ```
153+
* // 浏览器
154+
* <script type="text/javascript" src="{cdn}"></script>
155+
* <script>
156+
* const result = {namespace}.getServiceKey(serviceUrl);
157+
*
158+
* </script>
159+
*
160+
* // ES6 Import
161+
* import { getServiceKey } from '{npm}';
162+
*
163+
* const result = getServiceKey(serviceUrl);
164+
* ```
151165
*/
152166
export async function getServiceKey(serviceUrl) {
153167
try {

0 commit comments

Comments
 (0)