delectusnon 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.prettierignore +2 -0
- package/.travis.yml +33 -0
- package/.vscode/launch.json +24 -0
- package/.vscode/settings.json +3 -0
- package/demos/ago-node-cli/README.md +29 -0
- package/demos/ago-node-cli/ago.js +32 -0
- package/demos/ago-node-cli/index.js +11 -0
- package/demos/ago-node-cli/lib/item-export-command.js +48 -0
- package/demos/ago-node-cli/lib/item-search-command.js +35 -0
- package/demos/ago-node-cli/package-lock.json +172 -0
- package/demos/ago-node-cli/package.json +30 -0
- package/demos/attachments/README.md +5 -0
- package/demos/attachments/index.html +164 -0
- package/demos/attachments/package-lock.json +182 -0
- package/demos/attachments/package.json +18 -0
- package/demos/batch-geocoder-node/NYC_Restaurant_Inspection_Results.csv +100 -0
- package/demos/batch-geocoder-node/README.md +15 -0
- package/demos/batch-geocoder-node/batch-geocode.js +118 -0
- package/demos/batch-geocoder-node/config-template.js +18 -0
- package/demos/batch-geocoder-node/package-lock.json +116 -0
- package/demos/batch-geocoder-node/package.json +39 -0
- package/demos/express/README.md +10 -0
- package/demos/express/config.json.template +3 -0
- package/demos/express/package-lock.json +473 -0
- package/demos/express/package.json +18 -0
- package/demos/express/server.js +28 -0
- package/demos/feature-service-browser/README.md +6 -0
- package/demos/feature-service-browser/index.html +122 -0
- package/demos/feature-service-browser/package-lock.json +182 -0
- package/demos/feature-service-browser/package.json +18 -0
- package/demos/geocoder-browser/README.md +10 -0
- package/demos/geocoder-browser/config.js.template +1 -0
- package/demos/geocoder-browser/index.html +131 -0
- package/demos/geocoder-browser/package-lock.json +182 -0
- package/demos/geocoder-browser/package.json +19 -0
- package/demos/geocoder-browser/post-sign-in.html +25 -0
- package/demos/jsapi-integration/README.md +8 -0
- package/demos/jsapi-integration/config.js +6 -0
- package/demos/jsapi-integration/index.html +79 -0
- package/demos/jsapi-integration/package-lock.json +184 -0
- package/demos/jsapi-integration/package.json +19 -0
- package/demos/oauth2-browser/README.md +12 -0
- package/demos/oauth2-browser/authenticate.html +32 -0
- package/demos/oauth2-browser/config.js.template +6 -0
- package/demos/oauth2-browser/index.html +202 -0
- package/demos/oauth2-browser/logo.svg +4 -0
- package/demos/oauth2-browser/package-lock.json +163 -0
- package/demos/oauth2-browser/package.json +18 -0
- package/demos/oauth2-browser/style.css +36 -0
- package/demos/oauth2-browser-retry/README.md +25 -0
- package/demos/oauth2-browser-retry/authenticate.html +21 -0
- package/demos/oauth2-browser-retry/index.html +116 -0
- package/demos/oauth2-browser-retry/logo.svg +4 -0
- package/demos/vue/.env.example +11 -0
- package/demos/vue/.eslintrc.js +17 -0
- package/demos/vue/.postcssrc.js +5 -0
- package/demos/vue/README.md +17 -0
- package/demos/vue/babel.config.js +3 -0
- package/demos/vue/package-lock.json +11323 -0
- package/demos/vue/package.json +33 -0
- package/demos/vue/public/favicon.ico +0 -0
- package/demos/vue/public/index.html +24 -0
- package/demos/vue/src/assets/logo.svg +29 -0
- package/demos/vue/src/components/App.vue +308 -0
- package/demos/vue/src/components/Authenticate.vue +65 -0
- package/demos/vue/src/components/Loader.vue +230 -0
- package/demos/vue/src/main.js +92 -0
- package/docs/FAQ.md +28 -0
- package/docs/HISTORY.md +62 -0
- package/docs/acetate.config.js +223 -0
- package/docs/build-typedoc.js +301 -0
- package/docs/src/_layout.html +82 -0
- package/docs/src/api/_declaration.html +496 -0
- package/docs/src/api/_layout.html +127 -0
- package/docs/src/api/_package.html +13 -0
- package/docs/src/api/index.html +23 -0
- package/docs/src/guides/_layout.html +24 -0
- package/docs/src/guides/amd-requirejs-dojo.md +40 -0
- package/docs/src/guides/babel-and-rollup.md +30 -0
- package/docs/src/guides/babel-and-webpack.md +30 -0
- package/docs/src/guides/browser-authentication.md +31 -0
- package/docs/src/guides/browserify.md +9 -0
- package/docs/src/guides/cli-authentication.md +9 -0
- package/docs/src/guides/client-server-authentication.md +9 -0
- package/docs/src/guides/from-a-cdn.md +36 -0
- package/docs/src/guides/index.md +52 -0
- package/docs/src/guides/node.md +70 -0
- package/docs/src/guides/package-overview.md +8 -0
- package/docs/src/guides/server-authentication.md +9 -0
- package/docs/src/guides/typescript-and-webpack.md +9 -0
- package/docs/src/img/icons.png +0 -0
- package/docs/src/img/icons@2x.png +0 -0
- package/docs/src/index.html +12 -0
- package/docs/src/js/api-search.js +112 -0
- package/docs/src/js/nav-toggle.js +41 -0
- package/docs/src/sass/_highlight.scss +96 -0
- package/docs/src/sass/_icons.scss +157 -0
- package/docs/src/sass/style.scss +169 -0
- package/jasmine.json +7 -0
- package/karma.conf.js +100 -0
- package/lerna.json +8 -0
- package/notes/README.md +88 -0
- package/package.json +88 -0
- package/packages/arcgis-rest-auth/README.md +64 -0
- package/packages/arcgis-rest-auth/package-lock.json +11 -0
- package/packages/arcgis-rest-auth/package.json +51 -0
- package/packages/arcgis-rest-auth/src/ApplicationSession.ts +109 -0
- package/packages/arcgis-rest-auth/src/UserSession.ts +873 -0
- package/packages/arcgis-rest-auth/src/authenticated-request-options.ts +24 -0
- package/packages/arcgis-rest-auth/src/fetch-token.ts +52 -0
- package/packages/arcgis-rest-auth/src/generate-token.ts +39 -0
- package/packages/arcgis-rest-auth/src/index.ts +8 -0
- package/packages/arcgis-rest-auth/test/ApplicationSession.test.ts +124 -0
- package/packages/arcgis-rest-auth/test/UserSession.test.ts +995 -0
- package/packages/arcgis-rest-auth/test/fetchToken.test.ts +112 -0
- package/packages/arcgis-rest-auth/test/generateToken.test.ts +130 -0
- package/packages/arcgis-rest-auth/test/utils.ts +14 -0
- package/packages/arcgis-rest-auth/tsconfig.json +6 -0
- package/packages/arcgis-rest-common-types/README.md +61 -0
- package/packages/arcgis-rest-common-types/package.json +38 -0
- package/packages/arcgis-rest-common-types/src/group.ts +54 -0
- package/packages/arcgis-rest-common-types/src/index.ts +467 -0
- package/packages/arcgis-rest-common-types/src/item.ts +45 -0
- package/packages/arcgis-rest-common-types/src/webmap.ts +1232 -0
- package/packages/arcgis-rest-common-types/tsconfig.json +11 -0
- package/packages/arcgis-rest-feature-service/README.md +70 -0
- package/packages/arcgis-rest-feature-service/package-lock.json +11 -0
- package/packages/arcgis-rest-feature-service/package.json +50 -0
- package/packages/arcgis-rest-feature-service/src/add.ts +81 -0
- package/packages/arcgis-rest-feature-service/src/addAttachment.ts +65 -0
- package/packages/arcgis-rest-feature-service/src/delete.ts +85 -0
- package/packages/arcgis-rest-feature-service/src/deleteAttachments.ts +68 -0
- package/packages/arcgis-rest-feature-service/src/getAttachments.ts +64 -0
- package/packages/arcgis-rest-feature-service/src/helpers.ts +80 -0
- package/packages/arcgis-rest-feature-service/src/index.ts +12 -0
- package/packages/arcgis-rest-feature-service/src/query.ts +172 -0
- package/packages/arcgis-rest-feature-service/src/queryRelated.ts +91 -0
- package/packages/arcgis-rest-feature-service/src/update.ts +81 -0
- package/packages/arcgis-rest-feature-service/src/updateAttachment.ts +74 -0
- package/packages/arcgis-rest-feature-service/test/attachments.test.ts +203 -0
- package/packages/arcgis-rest-feature-service/test/features.test.ts +252 -0
- package/packages/arcgis-rest-feature-service/test/mocks/feature.ts +279 -0
- package/packages/arcgis-rest-feature-service/test/mocks/foo.txt +1 -0
- package/packages/arcgis-rest-feature-service/tsconfig.json +6 -0
- package/packages/arcgis-rest-feature-service-admin/README.md +66 -0
- package/packages/arcgis-rest-feature-service-admin/package-lock.json +11 -0
- package/packages/arcgis-rest-feature-service-admin/package.json +53 -0
- package/packages/arcgis-rest-feature-service-admin/src/addTo.ts +70 -0
- package/packages/arcgis-rest-feature-service-admin/src/create.ts +195 -0
- package/packages/arcgis-rest-feature-service-admin/src/index.ts +2 -0
- package/packages/arcgis-rest-feature-service-admin/test/addTo.test.ts +310 -0
- package/packages/arcgis-rest-feature-service-admin/test/create.test.ts +412 -0
- package/packages/arcgis-rest-feature-service-admin/test/mocks/move.ts +14 -0
- package/packages/arcgis-rest-feature-service-admin/test/mocks/service.ts +72 -0
- package/packages/arcgis-rest-feature-service-admin/tsconfig.json +6 -0
- package/packages/arcgis-rest-geocoder/README.md +79 -0
- package/packages/arcgis-rest-geocoder/package-lock.json +11 -0
- package/packages/arcgis-rest-geocoder/package.json +52 -0
- package/packages/arcgis-rest-geocoder/src/bulk.ts +102 -0
- package/packages/arcgis-rest-geocoder/src/geocode.ts +117 -0
- package/packages/arcgis-rest-geocoder/src/helpers.ts +79 -0
- package/packages/arcgis-rest-geocoder/src/index.ts +8 -0
- package/packages/arcgis-rest-geocoder/src/reverse.ts +84 -0
- package/packages/arcgis-rest-geocoder/src/suggest.ts +72 -0
- package/packages/arcgis-rest-geocoder/test/bulk.test.ts +113 -0
- package/packages/arcgis-rest-geocoder/test/geocode.test.ts +121 -0
- package/packages/arcgis-rest-geocoder/test/helpers.test.ts +113 -0
- package/packages/arcgis-rest-geocoder/test/mocks/responses.ts +591 -0
- package/packages/arcgis-rest-geocoder/test/reverse.test.ts +126 -0
- package/packages/arcgis-rest-geocoder/test/suggest.test.ts +77 -0
- package/packages/arcgis-rest-geocoder/tsconfig.json +6 -0
- package/packages/arcgis-rest-groups/README.md +64 -0
- package/packages/arcgis-rest-groups/package-lock.json +11 -0
- package/packages/arcgis-rest-groups/package.json +52 -0
- package/packages/arcgis-rest-groups/src/create.ts +34 -0
- package/packages/arcgis-rest-groups/src/get.ts +95 -0
- package/packages/arcgis-rest-groups/src/helpers.ts +26 -0
- package/packages/arcgis-rest-groups/src/index.ts +11 -0
- package/packages/arcgis-rest-groups/src/notification.ts +77 -0
- package/packages/arcgis-rest-groups/src/protect.ts +40 -0
- package/packages/arcgis-rest-groups/src/remove.ts +23 -0
- package/packages/arcgis-rest-groups/src/search.ts +64 -0
- package/packages/arcgis-rest-groups/src/update.ts +36 -0
- package/packages/arcgis-rest-groups/test/crud.test.ts +104 -0
- package/packages/arcgis-rest-groups/test/get.test.ts +101 -0
- package/packages/arcgis-rest-groups/test/mocks/responses.ts +141 -0
- package/packages/arcgis-rest-groups/test/notification.test.ts +102 -0
- package/packages/arcgis-rest-groups/test/protect.test.ts +64 -0
- package/packages/arcgis-rest-groups/test/search.test.ts +85 -0
- package/packages/arcgis-rest-groups/tsconfig.json +6 -0
- package/packages/arcgis-rest-items/README.md +66 -0
- package/packages/arcgis-rest-items/package-lock.json +11 -0
- package/packages/arcgis-rest-items/package.json +52 -0
- package/packages/arcgis-rest-items/src/add.ts +103 -0
- package/packages/arcgis-rest-items/src/create.ts +110 -0
- package/packages/arcgis-rest-items/src/get.ts +79 -0
- package/packages/arcgis-rest-items/src/helpers.ts +147 -0
- package/packages/arcgis-rest-items/src/index.ts +11 -0
- package/packages/arcgis-rest-items/src/protect.ts +38 -0
- package/packages/arcgis-rest-items/src/remove.ts +58 -0
- package/packages/arcgis-rest-items/src/search.ts +78 -0
- package/packages/arcgis-rest-items/src/update.ts +134 -0
- package/packages/arcgis-rest-items/test/add.test.ts +256 -0
- package/packages/arcgis-rest-items/test/create.test.ts +371 -0
- package/packages/arcgis-rest-items/test/get.test.ts +181 -0
- package/packages/arcgis-rest-items/test/mocks/foo.zip +0 -0
- package/packages/arcgis-rest-items/test/mocks/item.ts +33 -0
- package/packages/arcgis-rest-items/test/mocks/resources.ts +31 -0
- package/packages/arcgis-rest-items/test/mocks/search.ts +63 -0
- package/packages/arcgis-rest-items/test/protect.test.ts +122 -0
- package/packages/arcgis-rest-items/test/remove.test.ts +161 -0
- package/packages/arcgis-rest-items/test/search.test.ts +159 -0
- package/packages/arcgis-rest-items/test/update.test.ts +450 -0
- package/packages/arcgis-rest-items/tsconfig.json +6 -0
- package/packages/arcgis-rest-request/README.md +65 -0
- package/packages/arcgis-rest-request/package-lock.json +11 -0
- package/packages/arcgis-rest-request/package.json +42 -0
- package/packages/arcgis-rest-request/src/index.ts +13 -0
- package/packages/arcgis-rest-request/src/request.ts +293 -0
- package/packages/arcgis-rest-request/src/utils/ArcGISAuthError.ts +67 -0
- package/packages/arcgis-rest-request/src/utils/ArcGISRequestError.ts +76 -0
- package/packages/arcgis-rest-request/src/utils/ErrorTypes.ts +29 -0
- package/packages/arcgis-rest-request/src/utils/check-for-errors.ts +65 -0
- package/packages/arcgis-rest-request/src/utils/encode-form-data.ts +34 -0
- package/packages/arcgis-rest-request/src/utils/encode-query-string.ts +23 -0
- package/packages/arcgis-rest-request/src/utils/get-portal-url.ts +25 -0
- package/packages/arcgis-rest-request/src/utils/get-portal.ts +45 -0
- package/packages/arcgis-rest-request/src/utils/process-params.ts +99 -0
- package/packages/arcgis-rest-request/test/mocks/errors.ts +68 -0
- package/packages/arcgis-rest-request/test/mocks/geojson-feature-collection.ts +13 -0
- package/packages/arcgis-rest-request/test/mocks/portal.ts +112 -0
- package/packages/arcgis-rest-request/test/mocks/sharing-rest-info.ts +41 -0
- package/packages/arcgis-rest-request/test/mocks/webmap.ts +41 -0
- package/packages/arcgis-rest-request/test/request.test.ts +299 -0
- package/packages/arcgis-rest-request/test/utils/ArcGISAuthError.test.ts +170 -0
- package/packages/arcgis-rest-request/test/utils/ArcGISRequestError.test.ts +51 -0
- package/packages/arcgis-rest-request/test/utils/check-for-errors.test.ts +111 -0
- package/packages/arcgis-rest-request/test/utils/encode-form-data.test.ts +133 -0
- package/packages/arcgis-rest-request/test/utils/get-portal-url.test.ts +37 -0
- package/packages/arcgis-rest-request/test/utils/portal.test.ts +97 -0
- package/packages/arcgis-rest-request/test/utils/process-params.test.ts +193 -0
- package/packages/arcgis-rest-request/tsconfig.json +6 -0
- package/packages/arcgis-rest-sharing/README.md +67 -0
- package/packages/arcgis-rest-sharing/package-lock.json +11 -0
- package/packages/arcgis-rest-sharing/package.json +57 -0
- package/packages/arcgis-rest-sharing/src/access.ts +85 -0
- package/packages/arcgis-rest-sharing/src/group-sharing.ts +211 -0
- package/packages/arcgis-rest-sharing/src/helpers.ts +82 -0
- package/packages/arcgis-rest-sharing/src/index.ts +5 -0
- package/packages/arcgis-rest-sharing/test/access.test.ts +154 -0
- package/packages/arcgis-rest-sharing/test/group-sharing.test.ts +566 -0
- package/packages/arcgis-rest-sharing/test/helpers.test.ts +55 -0
- package/packages/arcgis-rest-sharing/test/mocks/sharing.ts +18 -0
- package/packages/arcgis-rest-sharing/tsconfig.json +6 -0
- package/packages/arcgis-rest-users/README.md +71 -0
- package/packages/arcgis-rest-users/package-lock.json +11 -0
- package/packages/arcgis-rest-users/package.json +51 -0
- package/packages/arcgis-rest-users/src/get.ts +69 -0
- package/packages/arcgis-rest-users/src/index.ts +6 -0
- package/packages/arcgis-rest-users/src/invitation.ts +166 -0
- package/packages/arcgis-rest-users/src/notification.ts +73 -0
- package/packages/arcgis-rest-users/test/get.test.ts +99 -0
- package/packages/arcgis-rest-users/test/invitation.test.ts +169 -0
- package/packages/arcgis-rest-users/test/mocks/invitation.ts +70 -0
- package/packages/arcgis-rest-users/test/mocks/notification.ts +34 -0
- package/packages/arcgis-rest-users/test/mocks/user.ts +173 -0
- package/packages/arcgis-rest-users/test/notification.test.ts +83 -0
- package/packages/arcgis-rest-users/tsconfig.json +6 -0
- package/support/changelog.js +394 -0
- package/support/deploy-doc-site.js +16 -0
- package/support/publish.sh +43 -0
- package/support/test-helpers.js +8 -0
- package/tsconfig.json +69 -0
- package/tslint.json +15 -0
- package/umd-base-profile.js +82 -0
- package/umd-production-profile.js +13 -0
@@ -0,0 +1,496 @@
|
|
1
|
+
{% macro @type(type) -%}
|
2
|
+
{%- if type.declaration and type.declaration.children -%}
|
3
|
+
{<dl class="type-child-list clearfix">
|
4
|
+
{%- for child in type.declaration.children -%}
|
5
|
+
<dt class="type-child-name">{{child.name}}:</dt><dd class="type-child-type">{{ @type(child.type) }}</dd>
|
6
|
+
{%- endfor -%}
|
7
|
+
</dl>}
|
8
|
+
{%- endif -%}
|
9
|
+
|
10
|
+
{% if type.type === 'array' %}
|
11
|
+
<i class="no-wrap">{{ @type(type.elementType) }}<span class="text-light-gray">{{ '[]' }}</span></i>
|
12
|
+
{% endif %}
|
13
|
+
|
14
|
+
{%- if type.type === 'intrinsic' -%}
|
15
|
+
<i class="text-purple">{{type.name}}</i>
|
16
|
+
{%- endif -%}
|
17
|
+
|
18
|
+
{%- if type.type === 'reference' and type.id and API_TOOLS.findById(data.typedoc, type.id) -%}
|
19
|
+
<i><a href="{{ API_TOOLS.findById(data.typedoc, type.id).pageUrl }}">{{type.name}}</a></i>
|
20
|
+
{%- elif API_TOOLS.findByName(data.typedoc, type.name) -%}
|
21
|
+
<i><a href="{{ API_TOOLS.findByName(data.typedoc, type.name).pageUrl }}">{{type.name}}</a></i>
|
22
|
+
{%- elif type.type === 'reference' -%}
|
23
|
+
<i>{{type.name}}</i>
|
24
|
+
{%- endif -%}
|
25
|
+
|
26
|
+
{%- if type.type === 'reflection' and type.declaration.signatures.length > 0 -%}
|
27
|
+
<span class="code-face"><span class="text-light-gray">function</span><span class="text-light-gray">(</span>{{ @signatureParams(type.declaration.signatures[0].parameters) }}<span class="text-light-gray">) : </span>{{@type(type.declaration.signatures[0].type)}}</span>
|
28
|
+
{%- elif type.type === 'reflection' and type.declaration.id and API_TOOLS.findById(data.typedoc, type.declaration.id) -%}
|
29
|
+
{% set declaration = API_TOOLS.findById(data.typedoc, type.declaration.id) %}
|
30
|
+
<i><a href="{{ declaration.pageUrl }}">{{declaration.name}}</a></i>
|
31
|
+
{%- elif type.type === 'reflection' and type.declaration and type.declaration.indexSignature -%}
|
32
|
+
{% for signature in type.declaration.indexSignature %}
|
33
|
+
<i class="no-wrap">{% for param in signature.parameters%}[key: {{@type(param.type)}}]: {% endfor %}{{@type(signature.type)}}</i>
|
34
|
+
{% endfor %}
|
35
|
+
{%- elif type.type === 'reflection' -%}
|
36
|
+
<i>{{ type.name }}</i>
|
37
|
+
{%- endif -%}
|
38
|
+
|
39
|
+
{%- if type.type === 'union' -%}
|
40
|
+
<i>{%- for t in type.types -%}
|
41
|
+
{%- if t.type === 'stringLiteral' -%}
|
42
|
+
<span class="text-green">"{{t.value}}"</span>
|
43
|
+
{%- else -%}
|
44
|
+
{{ @type(t) }}
|
45
|
+
{%- endif -%}
|
46
|
+
|
47
|
+
{%- if (loop.last === false) -%}
|
48
|
+
<span class="text-light-gray">{{ ' | ' }}</span>
|
49
|
+
{%- endif -%}
|
50
|
+
{%- endfor -%}</i>
|
51
|
+
{%- endif -%}
|
52
|
+
|
53
|
+
{%- if type.type === 'tuple' -%}
|
54
|
+
<i class="no-wrap">{%- for t in type.elements -%}
|
55
|
+
{%- if (loop.first) -%}
|
56
|
+
<span class="text-light-gray">{{ '[' }}</span>
|
57
|
+
{%- endif -%}
|
58
|
+
{{ @type(t) }}
|
59
|
+
{%- if (loop.last === false) -%}
|
60
|
+
<span class="text-light-gray">{{ ', ' }}</span>
|
61
|
+
{%- endif -%}
|
62
|
+
{%- if (loop.last) -%}
|
63
|
+
<span class="text-light-gray">{{ ']' }}</span>
|
64
|
+
{%- endif -%}
|
65
|
+
{%- endfor -%}</i>
|
66
|
+
{%- endif -%}
|
67
|
+
|
68
|
+
{%- if type.typeArguments -%}
|
69
|
+
<i>{% for arg in type.typeArguments -%}
|
70
|
+
{%- if (loop.first) -%}<span class="text-light-gray">{{ '<' }}</span>{%- endif -%}
|
71
|
+
{{ @type(arg) }}
|
72
|
+
{%- if (loop.last) -%}<span class="text-light-gray">{{ '>' }}</span>{%- endif -%}
|
73
|
+
{%- endfor %}</i>
|
74
|
+
{%- endif -%}
|
75
|
+
{%- endmacro %}
|
76
|
+
|
77
|
+
{% macro @param(param) -%}
|
78
|
+
{{param.name}}: {{@type(param.type)}}
|
79
|
+
{%- endmacro %}
|
80
|
+
|
81
|
+
{% macro @signatureParams(params) -%}
|
82
|
+
{% for param in params -%}{{ @param(param) }}{{ ', ' if (loop.last === false)}}{%- endfor %}
|
83
|
+
{%- endmacro %}
|
84
|
+
|
85
|
+
{% macro @signature(signature) -%}
|
86
|
+
<li class="code-face tsd-signature tsd-kind-icon">{{ signature.name }}<span class="text-light-gray">(</span>{{ @signatureParams(signature.parameters) }}<span class="text-light-gray">) : </span>{{@type(signature.type)}}</li>
|
87
|
+
{%- endmacro %}
|
88
|
+
|
89
|
+
{% macro @inherited(inheritedFrom) -%}
|
90
|
+
{% if inheritedFrom %}
|
91
|
+
<span class="label">Inherited</span>
|
92
|
+
{% endif %}
|
93
|
+
{%- endmacro %}
|
94
|
+
|
95
|
+
{% macro @properties (group, children) %}
|
96
|
+
<table>
|
97
|
+
<thead>
|
98
|
+
<tr>
|
99
|
+
<th>{{ API_TOOLS.findChildById(group.children[0], children).kindString }}</th>
|
100
|
+
<th>{{ 'Value' if API_TOOLS.findChildById(group.children[0], children).defaultValue else 'Type' }}</th>
|
101
|
+
<th>Notes</th>
|
102
|
+
</tr>
|
103
|
+
</thead>
|
104
|
+
<tbody>
|
105
|
+
{% for id in group.children %}
|
106
|
+
{% set child = API_TOOLS.findChildById(id, children) %}
|
107
|
+
<tr id="{{child.name}}">
|
108
|
+
<td class="code-face {{child.icon}} no-wrap">
|
109
|
+
<a href="#{{child.name}}" class="table-link">
|
110
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
|
111
|
+
</a>
|
112
|
+
<span class="tsd-kind-icon">{{child.name}}</span>
|
113
|
+
{{ @flags(child.flags) }}
|
114
|
+
{{ @inherited(child.inheritedFrom) }}
|
115
|
+
</td>
|
116
|
+
<td class="code-face">
|
117
|
+
{% if child.defaultValue %}
|
118
|
+
{{ child.defaultValue }}
|
119
|
+
{% elif child.getSignature %}
|
120
|
+
{{ @type(child.getSignature[0].type) }}
|
121
|
+
{% else %}
|
122
|
+
{{ @type(child.type) }}
|
123
|
+
{% endif %}
|
124
|
+
</td>
|
125
|
+
<td class="body-face api-param-comment">
|
126
|
+
{% markdown -%}
|
127
|
+
{{ child.comment.shortText | safe | trim }}
|
128
|
+
{%- endmarkdown %}
|
129
|
+
</td>
|
130
|
+
</tr>
|
131
|
+
{% endfor %}
|
132
|
+
|
133
|
+
</tbody>
|
134
|
+
</table>
|
135
|
+
{% endmacro %}
|
136
|
+
|
137
|
+
{% macro @indexSignature (signatures, parentKind) %}
|
138
|
+
<table>
|
139
|
+
<thead>
|
140
|
+
<tr>
|
141
|
+
<th>Key Type</th>
|
142
|
+
<th>Value Type</th>
|
143
|
+
<th>Notes</th>
|
144
|
+
</tr>
|
145
|
+
</thead>
|
146
|
+
<tbody>
|
147
|
+
{% for child in signatures %}
|
148
|
+
<tr id="{{child.parameters[0].id}}">
|
149
|
+
<td class="code-face tsd-kind-index-signature tsd-parent-kind-{{parentKind | lower}} no-wrap">
|
150
|
+
<a href="#{{child.parameters[0].id}}" class="table-link">
|
151
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
|
152
|
+
</a>
|
153
|
+
<span class="tsd-kind-icon">{{ @type(child.parameters[0].type) }}</span>
|
154
|
+
</td>
|
155
|
+
<td class="code-face">
|
156
|
+
{% if child.defaultValue %}
|
157
|
+
{{ child.defaultValue }}
|
158
|
+
{% elif child.getSignature %}
|
159
|
+
{{ @type(child.getSignature[0].type) }}
|
160
|
+
{% else %}
|
161
|
+
{{ @type(child.type) }}
|
162
|
+
{% endif %}
|
163
|
+
</td>
|
164
|
+
<td class="body-face api-param-comment">
|
165
|
+
{% markdown -%}
|
166
|
+
{{ child.comment.shortText | safe | trim }}
|
167
|
+
{%- endmarkdown %}
|
168
|
+
</td>
|
169
|
+
</tr>
|
170
|
+
{% endfor %}
|
171
|
+
|
172
|
+
</tbody>
|
173
|
+
</table>
|
174
|
+
{% endmacro %}
|
175
|
+
|
176
|
+
{% macro @flags(flags) %}
|
177
|
+
{% if flags.isOptional %}
|
178
|
+
<span class="label">Optional</span>
|
179
|
+
{% endif %}
|
180
|
+
|
181
|
+
{% if flags.isPrivate %}
|
182
|
+
<span class="label">Private</span>
|
183
|
+
{% endif %}
|
184
|
+
|
185
|
+
{% if flags.isProtected %}
|
186
|
+
<span class="label">Protected</span>
|
187
|
+
{% endif %}
|
188
|
+
|
189
|
+
{% if flags.isRequired %}
|
190
|
+
<span class="label">Required</span>
|
191
|
+
{% endif %}
|
192
|
+
|
193
|
+
{% if flags.isStatic %}
|
194
|
+
<span class="label">Static</span>
|
195
|
+
{% endif %}
|
196
|
+
{% endmacro %}
|
197
|
+
|
198
|
+
{% macro @signatures(signatures) %}
|
199
|
+
{% markdown -%}
|
200
|
+
{{ signatures[0].comment.shortText | safe }}
|
201
|
+
{%- endmarkdown %}
|
202
|
+
|
203
|
+
<ul class="list-plain tsd-signatures {{icon}} trailer-half">
|
204
|
+
{% for signature in signatures %}
|
205
|
+
{{ @signature(signature) }}
|
206
|
+
{% endfor %}
|
207
|
+
</ul>
|
208
|
+
|
209
|
+
{% if signatures[0].parameters %}
|
210
|
+
<h2 class="font-size-1 trailer-half">Parameters</h2>
|
211
|
+
{{@parametersTable(signatures[0].parameters, signatures[0].name)}}
|
212
|
+
{% endif %}
|
213
|
+
|
214
|
+
<h2 class="font-size-1 trailer-half">Returns</h2>
|
215
|
+
|
216
|
+
{%- markdown -%}
|
217
|
+
<code>{{@type(signatures[0].type)}}</code>{{" - " if signatures[0].comment.returns}}{{ signatures[0].comment.returns | safe }}
|
218
|
+
{%- endmarkdown %}
|
219
|
+
|
220
|
+
{% if signatures[0].comment.text %}
|
221
|
+
<hr class="leader-half trailer-half">
|
222
|
+
|
223
|
+
{% markdown -%}
|
224
|
+
{{ signatures[0].comment.text | safe }}
|
225
|
+
{%- endmarkdown %}
|
226
|
+
{% endif %}
|
227
|
+
{% endmacro %}
|
228
|
+
|
229
|
+
{% macro @methodsTable(group, children) %}
|
230
|
+
<table>
|
231
|
+
<thead>
|
232
|
+
<tr>
|
233
|
+
<th>Method</th>
|
234
|
+
<th>Returns</th>
|
235
|
+
<th>Notes</th>
|
236
|
+
</tr>
|
237
|
+
</thead>
|
238
|
+
<tbody>
|
239
|
+
{% for childId in group.children %}
|
240
|
+
{% set child = API_TOOLS.findChildById(childId, children) %}
|
241
|
+
<tr id="{{child.signatures[0].name}}-summary">
|
242
|
+
<td>
|
243
|
+
<a href="#{{child.signatures[0].name}}-summary" class="table-link">
|
244
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
|
245
|
+
</a>
|
246
|
+
<ul class="method-table-signatures {{child.signatures[0].icon}}">
|
247
|
+
{% for signature in child.signatures -%}
|
248
|
+
<li class="code-face tsd-signature tsd-kind-icon">
|
249
|
+
<a href="#{{signature.name}}">{{ signature.name }}</a><span class="text-light-gray">(</span>{{ @signatureParams(signature.parameters) }}<span class="text-light-gray">)</span>
|
250
|
+
{{ @flags(child.flags) }}
|
251
|
+
{{ @inherited(child.inheritedFrom) }}
|
252
|
+
</li>
|
253
|
+
{%- endfor %}
|
254
|
+
</ul>
|
255
|
+
</td>
|
256
|
+
<td class="code-face">{{@type(child.signatures[0].type)}}</td>
|
257
|
+
<td class="body-face api-param-comment">
|
258
|
+
{% markdown -%}
|
259
|
+
{{ child.signatures[0].comment.shortText | safe | trim }}
|
260
|
+
{%- endmarkdown %}
|
261
|
+
{% markdown -%}
|
262
|
+
{{ child.signatures[0].comment.text | safe | trim }}
|
263
|
+
{%- endmarkdown %}
|
264
|
+
</td>
|
265
|
+
</tr>
|
266
|
+
{% endfor %}
|
267
|
+
</tbody>
|
268
|
+
</table>
|
269
|
+
|
270
|
+
{% for childId in group.children %}
|
271
|
+
{% set child = API_TOOLS.findChildById(childId, children) %}
|
272
|
+
{% set signatures = child.signatures %}
|
273
|
+
<div id="{{signatures[0].name}}" class="method-panel panel panel-white padding-trailer-0 leader-1 trailer-1">
|
274
|
+
<header class="clearfix">
|
275
|
+
<a href="#{{signatures[0].name}}" class="table-link">
|
276
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
|
277
|
+
</a>
|
278
|
+
<h3 class="font-size-2 code-face trailer-0 margin-right-half left">{{signatures[0].name}}</h3>
|
279
|
+
{{ @flags(child.flags)}}
|
280
|
+
<small class="{{signatures[0].icon}} font-size--2 right">
|
281
|
+
<span class="tsd-kind-icon">
|
282
|
+
{% if child.flags.isStatic %}
|
283
|
+
Static {{kindString}} Method
|
284
|
+
{% elif child.flags.isPrivate %}
|
285
|
+
Private {{kindString}} Method
|
286
|
+
{% elif child.flags.isProtected %}
|
287
|
+
Protected {{kindString}} Method
|
288
|
+
{% else %}
|
289
|
+
{{kindString}} Method
|
290
|
+
{% endif %}
|
291
|
+
</span>
|
292
|
+
</small>
|
293
|
+
</header>
|
294
|
+
|
295
|
+
<hr class="leader-half trailer-half">
|
296
|
+
|
297
|
+
<div class="api-function-comment">
|
298
|
+
{% markdown -%}
|
299
|
+
{{ signatures[0].comment.shortText | safe }}
|
300
|
+
{%- endmarkdown %}
|
301
|
+
</div>
|
302
|
+
|
303
|
+
<ul class="list-plain tsd-signatures trailer-half {{signatures[0].icon}}">
|
304
|
+
{% for signature in signatures %}
|
305
|
+
{{ @signature(signature) }}
|
306
|
+
{% endfor %}
|
307
|
+
</ul>
|
308
|
+
|
309
|
+
{% if signatures[0].parameters %}
|
310
|
+
<h2 class="font-size-1 trailer-half">Parameters</h2>
|
311
|
+
{{@parametersTable(signatures[0].parameters, signatures[0].name)}}
|
312
|
+
{% endif %}
|
313
|
+
|
314
|
+
<h2 class="font-size-1 trailer-half">Returns</h2>
|
315
|
+
|
316
|
+
{%- markdown -%}
|
317
|
+
<code>{{@type(signatures[0].type)}}</code>{{" - " if signatures[0].comment.returns}}{{ signatures[0].comment.returns | safe }}
|
318
|
+
{%- endmarkdown %}
|
319
|
+
|
320
|
+
{% if signatures[0].comment.text %}
|
321
|
+
<hr class="leader-half trailer-half">
|
322
|
+
|
323
|
+
{% markdown -%}
|
324
|
+
{{ signatures[0].comment.text | safe }}
|
325
|
+
{%- endmarkdown %}
|
326
|
+
{% endif %}
|
327
|
+
</div>
|
328
|
+
{% endfor %}
|
329
|
+
{% endmacro %}
|
330
|
+
|
331
|
+
{% macro @accessorsTable(group, children) %}
|
332
|
+
{{ @properties(group, children) }}
|
333
|
+
{# @TODO make a custom table when and if we need setters... #}
|
334
|
+
{% endmacro %}
|
335
|
+
|
336
|
+
{% macro @parametersTable(parameters, fnName) %}
|
337
|
+
<table>
|
338
|
+
<thead>
|
339
|
+
<tr>
|
340
|
+
<th class="font-size--2">Parameter</th>
|
341
|
+
<th class="font-size--2">Type</th>
|
342
|
+
<th class="font-size--2">Default</th>
|
343
|
+
<th class="font-size--2">Notes</th>
|
344
|
+
</tr>
|
345
|
+
</thead>
|
346
|
+
<tbody>
|
347
|
+
{% for param in parameters -%}
|
348
|
+
<tr id="{{fnName}}-{{param.name}}">
|
349
|
+
<td class="code-face">
|
350
|
+
<a href="#{{fnName}}-{{param.name}}" class="table-link">
|
351
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
|
352
|
+
</a>
|
353
|
+
<span class="code-face">{{param.name}}</span>
|
354
|
+
{% if param.defaultValue %}
|
355
|
+
{{ @flags({isOptional: true}) }}
|
356
|
+
{% elif not param.defaultValue and not param.flags.isOptional %}
|
357
|
+
{{ @flags({isRequired: true}) }}
|
358
|
+
{% else %}
|
359
|
+
{{ @flags(param.flags) }}
|
360
|
+
{% endif %}
|
361
|
+
</td>
|
362
|
+
<td class="code-face">{{@type(param.type)}}</td>
|
363
|
+
<td class="code-face">{{param.defaultValue}}</td>
|
364
|
+
<td class="body-face api-param-comment">
|
365
|
+
{% markdown -%}
|
366
|
+
{{ param.comment.shortText | safe | trim }}
|
367
|
+
{%- endmarkdown %}
|
368
|
+
{% markdown -%}
|
369
|
+
{{ param.comment.text | safe | trim }}
|
370
|
+
{%- endmarkdown %}
|
371
|
+
</td>
|
372
|
+
</tr>
|
373
|
+
{%- endfor %}
|
374
|
+
</tbody>
|
375
|
+
</table>
|
376
|
+
{% endmacro %}
|
377
|
+
|
378
|
+
<div class="clearfix">
|
379
|
+
<h1 class="left font-size-5 code-face trailer-0">{{name}}</h1>
|
380
|
+
<small class="{{icon}} font-size--2 right"><span class="tsd-kind-icon">{{kindString}}</span></small>
|
381
|
+
</div>
|
382
|
+
|
383
|
+
<hr class="leader-half trailer-1">
|
384
|
+
|
385
|
+
{% if comment %}
|
386
|
+
{% markdown -%}
|
387
|
+
{{ comment.shortText | safe }}
|
388
|
+
{%- endmarkdown %}
|
389
|
+
{% endif %}
|
390
|
+
|
391
|
+
{% if implementedTypes %}
|
392
|
+
<h2>Implements</h2>
|
393
|
+
<ul class="list-plain trailer-1">
|
394
|
+
{% for implementedType in implementedTypes %}
|
395
|
+
{% if implementedType.id %}
|
396
|
+
{% set base = API_TOOLS.findById(data.typedoc, implementedType.id) %}
|
397
|
+
<li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
|
398
|
+
{% elif implementedType.name %}
|
399
|
+
{% set base = API_TOOLS.findByName(data.typedoc, implementedType.name) %}
|
400
|
+
{% if base %}
|
401
|
+
<li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
|
402
|
+
{% elif implementedType.name %}
|
403
|
+
<li class="code-face">{{base.name}}</li>
|
404
|
+
{% endif %}
|
405
|
+
{% endif %}
|
406
|
+
{% endfor %}
|
407
|
+
</ul>
|
408
|
+
{% endif %}
|
409
|
+
|
410
|
+
{% if extendedTypes %}
|
411
|
+
<h2>Extends</h2>
|
412
|
+
<ul class="list-plain trailer-1">
|
413
|
+
{% for extendedType in extendedTypes %}
|
414
|
+
{% if extendedType.id %}
|
415
|
+
{% set base = API_TOOLS.findById(data.typedoc, extendedType.id) %}
|
416
|
+
<li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
|
417
|
+
{% elif extendedType.name %}
|
418
|
+
{% set base = API_TOOLS.findByName(data.typedoc, extendedType.name) %}
|
419
|
+
{% if base %}
|
420
|
+
<li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
|
421
|
+
{% elif extendedType.name %}
|
422
|
+
<li class="code-face">{{base.name}}</li>
|
423
|
+
{% endif %}
|
424
|
+
{% endif %}
|
425
|
+
{% endfor %}
|
426
|
+
</ul>
|
427
|
+
{% endif %}
|
428
|
+
|
429
|
+
{% if type %}
|
430
|
+
Value(s):<br>
|
431
|
+
<pre>{{@type(type)}}</pre>
|
432
|
+
{% endif %}
|
433
|
+
|
434
|
+
{% if groups %}
|
435
|
+
{% for group in groups %}
|
436
|
+
<h2 class="font-size-3">{{group.title}}</h2>
|
437
|
+
|
438
|
+
{% if group.title == 'Enumeration members' %}
|
439
|
+
{{ @properties(group, children) }}
|
440
|
+
{% endif %}
|
441
|
+
|
442
|
+
{% if group.title == 'Properties' %}
|
443
|
+
{{ @properties(group, children) }}
|
444
|
+
{% endif %}
|
445
|
+
|
446
|
+
{% if group.title == 'Constructors' %}
|
447
|
+
{% set firstSignature = API_TOOLS.findChildById(group.children[0], children).signatures[0] %}
|
448
|
+
<ul class="list-plain trailer-1 {{ API_TOOLS.findChildById(group.children[0], children).icon }}">
|
449
|
+
{% for id in group.children %}
|
450
|
+
{% set signatures = API_TOOLS.findChildById(id, children).signatures %}
|
451
|
+
{% for signature in signatures %}
|
452
|
+
{{ @signature(signature) }}
|
453
|
+
{% endfor %}
|
454
|
+
{% endfor %}
|
455
|
+
</ul>
|
456
|
+
|
457
|
+
<h2 class="font-size-1">Constructor Parameters</h2>
|
458
|
+
{{@parametersTable(firstSignature.parameters, 'Constructor')}}
|
459
|
+
{% endif %}
|
460
|
+
|
461
|
+
{% if group.title == 'Accessors' %}
|
462
|
+
{{ @accessorsTable(group, children) }}
|
463
|
+
{% endif %}
|
464
|
+
|
465
|
+
{% if group.title == 'Methods' %}
|
466
|
+
{{ @methodsTable(group, children) }}
|
467
|
+
{% endif %}
|
468
|
+
|
469
|
+
{% endfor %}
|
470
|
+
{% endif %}
|
471
|
+
|
472
|
+
{% if indexSignature %}
|
473
|
+
<h3>Index Signatures</h3>
|
474
|
+
{{@indexSignature(indexSignature, kindString)}}
|
475
|
+
{% endif %}
|
476
|
+
|
477
|
+
{% if signatures %}
|
478
|
+
{{@signatures(signatures)}}
|
479
|
+
{% endif %}
|
480
|
+
|
481
|
+
{% if comment and comment.text %}
|
482
|
+
{% markdown -%}
|
483
|
+
{{ comment.text | safe }}
|
484
|
+
{%- endmarkdown %}
|
485
|
+
{% endif %}
|
486
|
+
|
487
|
+
<hr class="leader-half trailer-half">
|
488
|
+
|
489
|
+
<small class="font-size--2">{{kindString}} defined in <a href="https://github.com/Esri/arcgis-rest-js/blob/master/packages/{{sources[0].fileName}}#L{{sources[0].line}}">packages/{{sources[0].fileName}}:{{sources[0].line}}</a></small>
|
490
|
+
|
491
|
+
{% if isDev %}
|
492
|
+
<details class="leader-1">
|
493
|
+
<summary>Debug Info</summary>
|
494
|
+
<pre><code>{{__defaultMetadata.children[12].type.declaration.indexSignature[0].type.declaration | inspect}}</code></pre>
|
495
|
+
</details>
|
496
|
+
{% endif %}
|
@@ -0,0 +1,127 @@
|
|
1
|
+
{% extends "_layout" %}
|
2
|
+
|
3
|
+
{% block scripts %}
|
4
|
+
<script src="https://unpkg.com/vue@2.4.2/dist/vue.min.js"></script>
|
5
|
+
<script src="https://unpkg.com/fuse.js@3.0.5/dist/fuse.min.js"></script>
|
6
|
+
<script src="/arcgis-rest-js/js/index.js"></script>
|
7
|
+
<script src="/arcgis-rest-js/js/api-search.js"></script>
|
8
|
+
<script src="/arcgis-rest-js/js/nav-toggle.js"></script>
|
9
|
+
<script>
|
10
|
+
new Vue({
|
11
|
+
el: "#page"
|
12
|
+
});
|
13
|
+
</script>
|
14
|
+
|
15
|
+
{% endblock %}
|
16
|
+
|
17
|
+
{% block main %}
|
18
|
+
<div class="grid-container trailer-1 leader-1">
|
19
|
+
<div class="column-6">
|
20
|
+
<api-search base-url="/arcgis-rest-js/">
|
21
|
+
<ul class="list-plain">
|
22
|
+
{% for package in data.typedoc.packages %}
|
23
|
+
<li class="{{ package.icon }} api-list-item">
|
24
|
+
<nav-toggle index="{{loop.index}}" package-name="{{package.pkg.name}}"></nav-toggle>
|
25
|
+
<button id="trigger{{loop.index}}" class="btn btn-transparent api-toggle-button">
|
26
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M7 4h5l12 12-12 12H7l12-12L7 4z"/></svg>
|
27
|
+
</button>
|
28
|
+
{% link package.pageUrl, package.pkg.name, class="tsd-kind-icon" %}
|
29
|
+
<ul id="list{{loop.index}}" class="api-package-content-list">
|
30
|
+
{% for declaration in package.declarations %}
|
31
|
+
<li class="{{ declaration.icon }} padding-left-1 padding-right-1 visually-hidden">{% link declaration.pageUrl, declaration.name, class="tsd-kind-icon padding-right-1" %}</li>
|
32
|
+
{% endfor %}
|
33
|
+
</ul>
|
34
|
+
</li>
|
35
|
+
{% endfor %}
|
36
|
+
</ul>
|
37
|
+
</api-search>
|
38
|
+
</div>
|
39
|
+
|
40
|
+
<div class="column-18">
|
41
|
+
<div class="panel">
|
42
|
+
{% block content %}{% endblock %}
|
43
|
+
</div>
|
44
|
+
</div>
|
45
|
+
</div>
|
46
|
+
{% endblock %}
|
47
|
+
|
48
|
+
{% block footer %}
|
49
|
+
<div class="grid-container">
|
50
|
+
<div class="column-24">
|
51
|
+
<h2>Legend</h2>
|
52
|
+
<div class="block-group block-group-4-up tablet-block-group-2-up phone-block-group-1-up">
|
53
|
+
<div class="block">
|
54
|
+
<ul class="list-plain">
|
55
|
+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
56
|
+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
57
|
+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
58
|
+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
59
|
+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
60
|
+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
61
|
+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
62
|
+
</ul>
|
63
|
+
</div>
|
64
|
+
<div class="block">
|
65
|
+
<ul class="list-plain">
|
66
|
+
<li class="tsd-kind-enumeration"><span class="tsd-kind-icon">Enumeration</span></li>
|
67
|
+
<li class="tsd-kind-enumeration-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
68
|
+
<li class="tsd-kind-property tsd-parent-kind-enumeration"><span class="tsd-kind-icon">Property</span></li>
|
69
|
+
<li class="tsd-kind-method tsd-parent-kind-enumeration"><span class="tsd-kind-icon">Method</span></li>
|
70
|
+
</ul>
|
71
|
+
</div>
|
72
|
+
<div class="block">
|
73
|
+
<ul class="list-plain">
|
74
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
75
|
+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
76
|
+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
77
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
78
|
+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
79
|
+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
80
|
+
</ul>
|
81
|
+
</div>
|
82
|
+
<div class="block">
|
83
|
+
<ul class="list-plain">
|
84
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
85
|
+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
86
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
88
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
89
|
+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
90
|
+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
91
|
+
</ul>
|
92
|
+
</div>
|
93
|
+
<div class="block">
|
94
|
+
<ul class="list-plain">
|
95
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
96
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
97
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
98
|
+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
99
|
+
</ul>
|
100
|
+
</div>
|
101
|
+
<div class="block">
|
102
|
+
<ul class="list-plain">
|
103
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
104
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
105
|
+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
106
|
+
</ul>
|
107
|
+
</div>
|
108
|
+
<div class="block">
|
109
|
+
<ul class="list-plain">
|
110
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
111
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
112
|
+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
113
|
+
</ul>
|
114
|
+
</div>
|
115
|
+
<div class="block">
|
116
|
+
<ul class="list-plain">
|
117
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
118
|
+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
119
|
+
</ul>
|
120
|
+
</div>
|
121
|
+
</div>
|
122
|
+
|
123
|
+
<hr class="leader-half trailer-half">
|
124
|
+
</div>
|
125
|
+
</div>
|
126
|
+
|
127
|
+
{% endblock %}
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<small class="label right">Version {{pkg.version}}</small>
|
2
|
+
<h1 class="{{icon}} font-size-3 trailer-half"> {% link url, pkg.name, class="tsd-kind-icon" %}</h1>
|
3
|
+
<p class="trailer-half">{{pkg.description}}</p>
|
4
|
+
<h2 class="font-size--1 trailer-half">npm install:</h2>
|
5
|
+
<pre><code>{% npmInstallCmd pkg %}</code></pre>
|
6
|
+
<h2 class="font-size--1 trailer-half">CDN:</h2>
|
7
|
+
<pre><code>{% scriptTag pkg %}</code></pre>
|
8
|
+
<hr class="leader-half trailer-half">
|
9
|
+
<ul class="list-plain package-contents">
|
10
|
+
{% for declaration in declarations %}
|
11
|
+
<li class="{{ declaration.icon }}">{% link declaration.pageUrl, declaration.name, class="tsd-kind-icon" %}</li>
|
12
|
+
{% endfor %}
|
13
|
+
</ul>
|
@@ -0,0 +1,23 @@
|
|
1
|
+
---
|
2
|
+
layout: "api/_layout:content"
|
3
|
+
---
|
4
|
+
|
5
|
+
<h1 class="font-size-4">Packages</h1>
|
6
|
+
{% for package in data.typedoc.packages %}
|
7
|
+
<section class="panel panel-white leader-1">
|
8
|
+
<small class="label right">Version {{package.pkg.version}}</small>
|
9
|
+
<h2 class="{{package.icon}} font-size-3 trailer-half"> {% link package.pageUrl, package.pkg.name, class="tsd-kind-icon" %}</h2>
|
10
|
+
<p>{{package.pkg.description}}</p>
|
11
|
+
<h3 class="font-size--1 trailer-half">npm install:</h3>
|
12
|
+
<pre><code>{% npmInstallCmd package.pkg %}</code></pre>
|
13
|
+
<h3 class="font-size--1 trailer-half">CDN:</h3>
|
14
|
+
<pre><code>{% scriptTag package.pkg %}</code></pre>
|
15
|
+
<hr class="leader-half trailer-half">
|
16
|
+
<ul class="list-plain package-contents">
|
17
|
+
{% for declaration in package.declarations %}
|
18
|
+
<li class="{{declaration.icon}}">{% link declaration.pageUrl, declaration.name, class="tsd-kind-icon" %}</li>
|
19
|
+
{% endfor %}
|
20
|
+
</ul>
|
21
|
+
</section>
|
22
|
+
{% endfor %}
|
23
|
+
</div>
|