autnam 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.env.example +2 -0
- package/.eslintrc.json +37 -0
- package/.github/workflows/deploy-docs.yml +27 -0
- package/.github/workflows/pre-release-tests.yml +49 -0
- package/.github/workflows/pull-request-tests.yml +49 -0
- package/.github/workflows/release.yml +75 -0
- package/.prettierignore +2 -0
- package/.prettierrc +19 -0
- package/.vscode/launch.json +25 -0
- package/.vscode/settings.json +5 -0
- package/codecov.yml +7 -0
- package/commitlint.config.cjs +41 -0
- package/demos/.eslintrc.js +13 -0
- package/demos/ago-node-cli/README.md +30 -0
- package/demos/ago-node-cli/ago.js +31 -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 +32 -0
- package/demos/ago-node-cli/package.json +29 -0
- package/demos/attachments-browser/README.md +7 -0
- package/demos/attachments-browser/index.html +165 -0
- package/demos/attachments-browser/package.json +15 -0
- package/demos/attachments-node/README.md +4 -0
- package/demos/attachments-node/image.jpg +0 -0
- package/demos/attachments-node/index.js +89 -0
- package/demos/attachments-node/package.json +19 -0
- package/demos/batch-geocoder-node/NYC_Restaurant_Inspection_Results.csv +100 -0
- package/demos/batch-geocoder-node/README.md +13 -0
- package/demos/batch-geocoder-node/batch-geocode.js +112 -0
- package/demos/batch-geocoder-node/config-template.js +18 -0
- package/demos/batch-geocoder-node/package.json +34 -0
- package/demos/browser-es-modules/README.md +7 -0
- package/demos/browser-es-modules/index.html +38 -0
- package/demos/browser-es-modules/package.json +15 -0
- package/demos/deno/README.md +1 -0
- package/demos/deno/import_map.json +8 -0
- package/demos/deno/index.js +5 -0
- package/demos/express/README.md +16 -0
- package/demos/express/config.json.template +3 -0
- package/demos/express/package.json +15 -0
- package/demos/express/server.js +37 -0
- package/demos/feature-service-browser/README.md +8 -0
- package/demos/feature-service-browser/index.html +122 -0
- package/demos/feature-service-browser/package.json +15 -0
- package/demos/geocoder-browser/README.md +12 -0
- package/demos/geocoder-browser/authenticate.html +29 -0
- package/demos/geocoder-browser/config.js.template +1 -0
- package/demos/geocoder-browser/index.html +139 -0
- package/demos/geocoder-browser/package.json +15 -0
- package/demos/jsapi-integration/README.md +26 -0
- package/demos/jsapi-integration/authenticate.html +29 -0
- package/demos/jsapi-integration/config.js +6 -0
- package/demos/jsapi-integration/index.html +91 -0
- package/demos/jsapi-integration/package.json +15 -0
- package/demos/node-cli-item-management/README.md +11 -0
- package/demos/node-cli-item-management/index.js +229 -0
- package/demos/node-cli-item-management/package.json +24 -0
- package/demos/node-cli-item-management/screenshot.png +0 -0
- package/demos/node-common-js/README.md +4 -0
- package/demos/node-common-js/index.js +5 -0
- package/demos/node-common-js/package.json +15 -0
- package/demos/node-es-modules/README.md +4 -0
- package/demos/node-es-modules/index.js +5 -0
- package/demos/node-es-modules/package.json +16 -0
- package/demos/oauth2-browser/README.md +17 -0
- package/demos/oauth2-browser/authenticate.html +29 -0
- package/demos/oauth2-browser/config.js.template +6 -0
- package/demos/oauth2-browser/index.html +223 -0
- package/demos/oauth2-browser/logo.svg +4 -0
- package/demos/oauth2-browser/package.json +15 -0
- package/demos/oauth2-browser/style.css +36 -0
- package/demos/oauth2-browser-retry/README.md +32 -0
- package/demos/oauth2-browser-retry/authenticate.html +21 -0
- package/demos/oauth2-browser-retry/index.html +114 -0
- package/demos/oauth2-browser-retry/logo.svg +4 -0
- package/demos/oauth2-browser-retry/package.json +15 -0
- package/demos/parcel/README.md +8 -0
- package/demos/parcel/index.html +16 -0
- package/demos/parcel/index.js +8 -0
- package/demos/parcel/package.json +20 -0
- package/demos/snowpack/README.md +8 -0
- package/demos/snowpack/index.html +16 -0
- package/demos/snowpack/index.js +8 -0
- package/demos/snowpack/package.json +20 -0
- package/demos/snowpack/snowpack.config.js +3 -0
- package/demos/stream-response-to-file/README.md +7 -0
- package/demos/stream-response-to-file/index.js +36 -0
- package/demos/stream-response-to-file/output/.gitkeep +0 -0
- package/demos/stream-response-to-file/package.json +31 -0
- package/demos/tree-shaking-rollup/.babelrc +3 -0
- package/demos/tree-shaking-rollup/README.md +9 -0
- package/demos/tree-shaking-rollup/index.html +11 -0
- package/demos/tree-shaking-rollup/package.json +22 -0
- package/demos/tree-shaking-rollup/rollup.config.js +13 -0
- package/demos/tree-shaking-rollup/src/index.js +8 -0
- package/demos/tree-shaking-webpack/README.md +9 -0
- package/demos/tree-shaking-webpack/index.html +11 -0
- package/demos/tree-shaking-webpack/package.json +26 -0
- package/demos/tree-shaking-webpack/src/index.js +8 -0
- package/demos/tree-shaking-webpack/webpack.config.js +29 -0
- package/demos/vite/README.md +6 -0
- package/demos/vite/favicon.svg +15 -0
- package/demos/vite/index.html +13 -0
- package/demos/vite/main.js +8 -0
- package/demos/vite/package.json +18 -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.json +35 -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 +303 -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/demos/webmap-checker-sapper/.env.example +5 -0
- package/demos/webmap-checker-sapper/README.md +124 -0
- package/demos/webmap-checker-sapper/appveyor.yml +18 -0
- package/demos/webmap-checker-sapper/cypress/fixtures/example.json +5 -0
- package/demos/webmap-checker-sapper/cypress/integration/spec.js +19 -0
- package/demos/webmap-checker-sapper/cypress/plugins/index.js +17 -0
- package/demos/webmap-checker-sapper/cypress/support/commands.js +25 -0
- package/demos/webmap-checker-sapper/cypress/support/index.js +20 -0
- package/demos/webmap-checker-sapper/cypress.json +4 -0
- package/demos/webmap-checker-sapper/package.json +47 -0
- package/demos/webmap-checker-sapper/rollup.config.js +87 -0
- package/demos/webmap-checker-sapper/src/client.js +20 -0
- package/demos/webmap-checker-sapper/src/components/LayerStatus.html +108 -0
- package/demos/webmap-checker-sapper/src/components/Nav.html +21 -0
- package/demos/webmap-checker-sapper/src/components/WebMap.html +62 -0
- package/demos/webmap-checker-sapper/src/routes/_error.html +41 -0
- package/demos/webmap-checker-sapper/src/routes/_layout.html +21 -0
- package/demos/webmap-checker-sapper/src/routes/auth/authorize.js +18 -0
- package/demos/webmap-checker-sapper/src/routes/auth/exchange-token.js +20 -0
- package/demos/webmap-checker-sapper/src/routes/auth/post-sign-in.js +24 -0
- package/demos/webmap-checker-sapper/src/routes/auth/sign-out.js +10 -0
- package/demos/webmap-checker-sapper/src/routes/index.html +20 -0
- package/demos/webmap-checker-sapper/src/routes/webmaps/[webmapId].html +83 -0
- package/demos/webmap-checker-sapper/src/routes/webmaps/index.html +59 -0
- package/demos/webmap-checker-sapper/src/server.js +102 -0
- package/demos/webmap-checker-sapper/src/service-worker.js +82 -0
- package/demos/webmap-checker-sapper/src/template.html +33 -0
- package/demos/webmap-checker-sapper/src/userInfoMiddleware.js +21 -0
- package/demos/webmap-checker-sapper/src/utils.js +33 -0
- package/demos/webmap-checker-sapper/static/favicon.png +0 -0
- package/demos/webmap-checker-sapper/static/global.css +36 -0
- package/demos/webmap-checker-sapper/static/manifest.json +20 -0
- package/demos/webmap-checker-sapper/static/svelte-logo-192.png +0 -0
- package/demos/webmap-checker-sapper/static/svelte-logo-512.png +0 -0
- package/docs/.eslintrc.js +12 -0
- package/docs/FAQ.md +48 -0
- package/docs/HISTORY.md +62 -0
- package/docs/acetate.config.js +262 -0
- package/docs/build-typedoc.js +434 -0
- package/docs/generate-srihashes.js +61 -0
- package/docs/package.json +3 -0
- package/docs/src/_layout.html +86 -0
- package/docs/src/api/_declaration.html +600 -0
- package/docs/src/api/_layout.html +204 -0
- package/docs/src/api/_package.html +38 -0
- package/docs/src/api/index.html +16 -0
- package/docs/src/guides/_layout.html +24 -0
- package/docs/src/guides/amd-requirejs-dojo.md +40 -0
- package/docs/src/guides/browser-authentication.md +39 -0
- package/docs/src/guides/bundlers.md +52 -0
- package/docs/src/guides/cli-authentication.md +9 -0
- package/docs/src/guides/client-server-authentication.md +9 -0
- package/docs/src/guides/embedded-apps.md +106 -0
- package/docs/src/guides/from-a-cdn.md +38 -0
- package/docs/src/guides/index.md +59 -0
- package/docs/src/guides/node.md +84 -0
- package/docs/src/guides/package-overview.md +111 -0
- package/docs/src/guides/server-authentication.md +9 -0
- package/docs/src/guides/whats-new-v2-0.md +305 -0
- package/docs/src/img/icons.png +0 -0
- package/docs/src/img/icons@2x.png +0 -0
- package/docs/src/img/oauth-browser.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 +242 -0
- package/jasmine.json +7 -0
- package/jasmine.live.json +7 -0
- package/karma.conf.cjs +128 -0
- package/package.json +87 -0
- package/packages/arcgis-rest-auth/CHANGELOG.md +80 -0
- package/packages/arcgis-rest-auth/README.md +71 -0
- package/packages/arcgis-rest-auth/package.json +66 -0
- package/packages/arcgis-rest-auth/src/index.ts +34 -0
- package/packages/arcgis-rest-auth/tsconfig.json +6 -0
- package/packages/arcgis-rest-demographics/CHANGELOG.md +14 -0
- package/packages/arcgis-rest-demographics/README.md +74 -0
- package/packages/arcgis-rest-demographics/package.json +69 -0
- package/packages/arcgis-rest-demographics/src/getAvailableCountries.ts +113 -0
- package/packages/arcgis-rest-demographics/src/getAvailableDataCollections.ts +161 -0
- package/packages/arcgis-rest-demographics/src/getAvailableGeographyLevels.ts +86 -0
- package/packages/arcgis-rest-demographics/src/getGeography.ts +152 -0
- package/packages/arcgis-rest-demographics/src/helpers.ts +27 -0
- package/packages/arcgis-rest-demographics/src/index.ts +16 -0
- package/packages/arcgis-rest-demographics/src/queryDemographicData.ts +108 -0
- package/packages/arcgis-rest-demographics/test/getAvailableCountries.test.ts +89 -0
- package/packages/arcgis-rest-demographics/test/getAvailableDataCollections.test.ts +114 -0
- package/packages/arcgis-rest-demographics/test/getAvailableGeographyLevels.test.ts +69 -0
- package/packages/arcgis-rest-demographics/test/getGeography.test.ts +150 -0
- package/packages/arcgis-rest-demographics/test/mocks/responses.ts +4 -0
- package/packages/arcgis-rest-demographics/test/queryDemographicData.test.live.ts +50 -0
- package/packages/arcgis-rest-demographics/test/queryDemographicData.test.ts +127 -0
- package/packages/arcgis-rest-demographics/tsconfig.json +6 -0
- package/packages/arcgis-rest-feature-service/CHANGELOG.md +44 -0
- package/packages/arcgis-rest-feature-service/README.md +75 -0
- package/packages/arcgis-rest-feature-service/package.json +70 -0
- package/packages/arcgis-rest-feature-service/src/add.ts +55 -0
- package/packages/arcgis-rest-feature-service/src/addAttachment.ts +53 -0
- package/packages/arcgis-rest-feature-service/src/addToServiceDefinition.ts +74 -0
- package/packages/arcgis-rest-feature-service/src/applyEdits.ts +94 -0
- package/packages/arcgis-rest-feature-service/src/createFeatureService.ts +191 -0
- package/packages/arcgis-rest-feature-service/src/decodeValues.ts +126 -0
- package/packages/arcgis-rest-feature-service/src/delete.ts +62 -0
- package/packages/arcgis-rest-feature-service/src/deleteAttachments.ts +52 -0
- package/packages/arcgis-rest-feature-service/src/getAllLayersAndTables.ts +30 -0
- package/packages/arcgis-rest-feature-service/src/getAttachments.ts +55 -0
- package/packages/arcgis-rest-feature-service/src/getLayer.ts +23 -0
- package/packages/arcgis-rest-feature-service/src/getService.ts +25 -0
- package/packages/arcgis-rest-feature-service/src/getServiceAdminInfo.ts +33 -0
- package/packages/arcgis-rest-feature-service/src/getViewSources.ts +19 -0
- package/packages/arcgis-rest-feature-service/src/helpers.ts +768 -0
- package/packages/arcgis-rest-feature-service/src/index.ts +37 -0
- package/packages/arcgis-rest-feature-service/src/query.ts +200 -0
- package/packages/arcgis-rest-feature-service/src/queryRelated.ts +86 -0
- package/packages/arcgis-rest-feature-service/src/update.ts +65 -0
- package/packages/arcgis-rest-feature-service/src/updateAttachment.ts +59 -0
- package/packages/arcgis-rest-feature-service/src/updateServiceDefinition.ts +53 -0
- package/packages/arcgis-rest-feature-service/test/addToServiceDefinition.test.ts +350 -0
- package/packages/arcgis-rest-feature-service/test/attachments.test.ts +188 -0
- package/packages/arcgis-rest-feature-service/test/createFeatureService.test.ts +279 -0
- package/packages/arcgis-rest-feature-service/test/crud.test.ts +196 -0
- package/packages/arcgis-rest-feature-service/test/decodeValues.test.ts +66 -0
- package/packages/arcgis-rest-feature-service/test/getAllLayersAndTables.test.ts +27 -0
- package/packages/arcgis-rest-feature-service/test/getLayer.test.ts +30 -0
- package/packages/arcgis-rest-feature-service/test/getService.test.ts +30 -0
- package/packages/arcgis-rest-feature-service/test/getServiceAdminInfo.test.ts +41 -0
- package/packages/arcgis-rest-feature-service/test/getViewSources.test.ts +45 -0
- package/packages/arcgis-rest-feature-service/test/helpers.test.ts +27 -0
- package/packages/arcgis-rest-feature-service/test/mocks/allLayersAndTablesResponse.ts +950 -0
- package/packages/arcgis-rest-feature-service/test/mocks/cvdQueryResponse.ts +225 -0
- package/packages/arcgis-rest-feature-service/test/mocks/feature.ts +302 -0
- package/packages/arcgis-rest-feature-service/test/mocks/fields.ts +779 -0
- package/packages/arcgis-rest-feature-service/test/mocks/foo.txt +1 -0
- package/packages/arcgis-rest-feature-service/test/mocks/layerDefinition.ts +80 -0
- package/packages/arcgis-rest-feature-service/test/mocks/service.ts +476 -0
- package/packages/arcgis-rest-feature-service/test/query.test.ts +166 -0
- package/packages/arcgis-rest-feature-service/test/updateServiceDefinition.test.ts +103 -0
- package/packages/arcgis-rest-feature-service/tsconfig.json +9 -0
- package/packages/arcgis-rest-fetch/README.md +17 -0
- package/packages/arcgis-rest-fetch/browser-ponyfill.js +8 -0
- package/packages/arcgis-rest-fetch/browser-ponyfill.mjs +8 -0
- package/packages/arcgis-rest-fetch/index.types.d.ts +8 -0
- package/packages/arcgis-rest-fetch/node-ponyfill.js +10 -0
- package/packages/arcgis-rest-fetch/node-ponyfill.mjs +10 -0
- package/packages/arcgis-rest-fetch/package.json +21 -0
- package/packages/arcgis-rest-form-data/README.md +15 -0
- package/packages/arcgis-rest-form-data/browser-ponyfill.js +5 -0
- package/packages/arcgis-rest-form-data/browser-ponyfill.mjs +3 -0
- package/packages/arcgis-rest-form-data/index.types.d.ts +9 -0
- package/packages/arcgis-rest-form-data/node-ponyfill.js +7 -0
- package/packages/arcgis-rest-form-data/node-ponyfill.mjs +5 -0
- package/packages/arcgis-rest-form-data/package.json +21 -0
- package/packages/arcgis-rest-geocoding/CHANGELOG.md +26 -0
- package/packages/arcgis-rest-geocoding/README.md +85 -0
- package/packages/arcgis-rest-geocoding/package.json +69 -0
- package/packages/arcgis-rest-geocoding/src/bulk.ts +106 -0
- package/packages/arcgis-rest-geocoding/src/geocode.ts +169 -0
- package/packages/arcgis-rest-geocoding/src/helpers.ts +56 -0
- package/packages/arcgis-rest-geocoding/src/index.ts +17 -0
- package/packages/arcgis-rest-geocoding/src/reverse.ts +82 -0
- package/packages/arcgis-rest-geocoding/src/suggest.ts +45 -0
- package/packages/arcgis-rest-geocoding/test/bulk.test.ts +193 -0
- package/packages/arcgis-rest-geocoding/test/geocode.test.ts +254 -0
- package/packages/arcgis-rest-geocoding/test/helpers.test.ts +85 -0
- package/packages/arcgis-rest-geocoding/test/mocks/responses.ts +1031 -0
- package/packages/arcgis-rest-geocoding/test/reverse.test.ts +124 -0
- package/packages/arcgis-rest-geocoding/test/suggest.test.ts +53 -0
- package/packages/arcgis-rest-geocoding/tsconfig.json +6 -0
- package/packages/arcgis-rest-portal/CHANGELOG.md +73 -0
- package/packages/arcgis-rest-portal/README.md +72 -0
- package/packages/arcgis-rest-portal/package.json +68 -0
- package/packages/arcgis-rest-portal/src/groups/add-users.ts +140 -0
- package/packages/arcgis-rest-portal/src/groups/create.ts +42 -0
- package/packages/arcgis-rest-portal/src/groups/get.ts +187 -0
- package/packages/arcgis-rest-portal/src/groups/helpers.ts +14 -0
- package/packages/arcgis-rest-portal/src/groups/invite-users.ts +141 -0
- package/packages/arcgis-rest-portal/src/groups/join.ts +57 -0
- package/packages/arcgis-rest-portal/src/groups/notification.ts +77 -0
- package/packages/arcgis-rest-portal/src/groups/protect.ts +56 -0
- package/packages/arcgis-rest-portal/src/groups/remove-users.ts +84 -0
- package/packages/arcgis-rest-portal/src/groups/remove.ts +32 -0
- package/packages/arcgis-rest-portal/src/groups/search.ts +48 -0
- package/packages/arcgis-rest-portal/src/groups/update-user-membership.ts +63 -0
- package/packages/arcgis-rest-portal/src/groups/update.ts +39 -0
- package/packages/arcgis-rest-portal/src/helpers.ts +83 -0
- package/packages/arcgis-rest-portal/src/index.ts +68 -0
- package/packages/arcgis-rest-portal/src/items/add.ts +145 -0
- package/packages/arcgis-rest-portal/src/items/content.ts +70 -0
- package/packages/arcgis-rest-portal/src/items/create.ts +149 -0
- package/packages/arcgis-rest-portal/src/items/export.ts +92 -0
- package/packages/arcgis-rest-portal/src/items/get.ts +444 -0
- package/packages/arcgis-rest-portal/src/items/helpers.ts +272 -0
- package/packages/arcgis-rest-portal/src/items/protect.ts +41 -0
- package/packages/arcgis-rest-portal/src/items/reassign.ts +59 -0
- package/packages/arcgis-rest-portal/src/items/remove.ts +139 -0
- package/packages/arcgis-rest-portal/src/items/search.ts +25 -0
- package/packages/arcgis-rest-portal/src/items/update.ts +188 -0
- package/packages/arcgis-rest-portal/src/items/upload.ts +124 -0
- package/packages/arcgis-rest-portal/src/orgs/notification.ts +148 -0
- package/packages/arcgis-rest-portal/src/services/get-unique-service-name.ts +35 -0
- package/packages/arcgis-rest-portal/src/services/is-service-name-available.ts +29 -0
- package/packages/arcgis-rest-portal/src/sharing/access.ts +84 -0
- package/packages/arcgis-rest-portal/src/sharing/helpers.ts +80 -0
- package/packages/arcgis-rest-portal/src/sharing/is-item-shared-with-group.ts +42 -0
- package/packages/arcgis-rest-portal/src/sharing/share-item-with-group.ts +335 -0
- package/packages/arcgis-rest-portal/src/sharing/unshare-item-with-group.ts +114 -0
- package/packages/arcgis-rest-portal/src/users/get-user-tags.ts +52 -0
- package/packages/arcgis-rest-portal/src/users/get-user-url.ts +18 -0
- package/packages/arcgis-rest-portal/src/users/get-user.ts +60 -0
- package/packages/arcgis-rest-portal/src/users/invitation.ts +157 -0
- package/packages/arcgis-rest-portal/src/users/notification.ts +67 -0
- package/packages/arcgis-rest-portal/src/users/search-users.ts +35 -0
- package/packages/arcgis-rest-portal/src/users/update.ts +63 -0
- package/packages/arcgis-rest-portal/src/util/SearchQueryBuilder.ts +391 -0
- package/packages/arcgis-rest-portal/src/util/array.ts +16 -0
- package/packages/arcgis-rest-portal/src/util/generic-search.ts +111 -0
- package/packages/arcgis-rest-portal/src/util/get-portal-settings.ts +44 -0
- package/packages/arcgis-rest-portal/src/util/get-portal-url.ts +32 -0
- package/packages/arcgis-rest-portal/src/util/get-portal.ts +53 -0
- package/packages/arcgis-rest-portal/src/util/get-subscription-info.ts +43 -0
- package/packages/arcgis-rest-portal/src/util/scrub-control-chars.ts +13 -0
- package/packages/arcgis-rest-portal/src/util/search.ts +48 -0
- package/packages/arcgis-rest-portal/test/groups/add-users.test.ts +238 -0
- package/packages/arcgis-rest-portal/test/groups/crud.test.ts +183 -0
- package/packages/arcgis-rest-portal/test/groups/get.test.ts +174 -0
- package/packages/arcgis-rest-portal/test/groups/invite-users.test.ts +146 -0
- package/packages/arcgis-rest-portal/test/groups/join.test.ts +71 -0
- package/packages/arcgis-rest-portal/test/groups/notification.test.ts +111 -0
- package/packages/arcgis-rest-portal/test/groups/protect.test.ts +71 -0
- package/packages/arcgis-rest-portal/test/groups/remove-users.test.ts +140 -0
- package/packages/arcgis-rest-portal/test/groups/search.test.ts +151 -0
- package/packages/arcgis-rest-portal/test/groups/update-user-membership.test.ts +64 -0
- package/packages/arcgis-rest-portal/test/items/add.test.ts +320 -0
- package/packages/arcgis-rest-portal/test/items/content.test.ts +161 -0
- package/packages/arcgis-rest-portal/test/items/create.test.ts +404 -0
- package/packages/arcgis-rest-portal/test/items/export.test.ts +115 -0
- package/packages/arcgis-rest-portal/test/items/get.test.ts +606 -0
- package/packages/arcgis-rest-portal/test/items/helpers.test.ts +60 -0
- package/packages/arcgis-rest-portal/test/items/protect.test.ts +120 -0
- package/packages/arcgis-rest-portal/test/items/reassign.test.ts +130 -0
- package/packages/arcgis-rest-portal/test/items/remove.test.ts +259 -0
- package/packages/arcgis-rest-portal/test/items/search.test.ts +274 -0
- package/packages/arcgis-rest-portal/test/items/update.test.ts +549 -0
- package/packages/arcgis-rest-portal/test/items/upload.test.ts +286 -0
- package/packages/arcgis-rest-portal/test/mocks/groups/responses.ts +208 -0
- package/packages/arcgis-rest-portal/test/mocks/items/foo.zip +0 -0
- package/packages/arcgis-rest-portal/test/mocks/items/item.ts +526 -0
- package/packages/arcgis-rest-portal/test/mocks/items/resources.ts +38 -0
- package/packages/arcgis-rest-portal/test/mocks/items/search.ts +121 -0
- package/packages/arcgis-rest-portal/test/mocks/portal/response.ts +126 -0
- package/packages/arcgis-rest-portal/test/mocks/portal/settings-response.ts +56 -0
- package/packages/arcgis-rest-portal/test/mocks/sharing/sharing.ts +18 -0
- package/packages/arcgis-rest-portal/test/mocks/users/invitation.ts +70 -0
- package/packages/arcgis-rest-portal/test/mocks/users/notification.ts +34 -0
- package/packages/arcgis-rest-portal/test/mocks/users/user-search.ts +388 -0
- package/packages/arcgis-rest-portal/test/mocks/users/user-tags.ts +5 -0
- package/packages/arcgis-rest-portal/test/mocks/users/user.ts +174 -0
- package/packages/arcgis-rest-portal/test/orgs/notification.test.ts +142 -0
- package/packages/arcgis-rest-portal/test/services/get-unique-service-name.test.ts +64 -0
- package/packages/arcgis-rest-portal/test/services/is-service-name-available.test.ts +41 -0
- package/packages/arcgis-rest-portal/test/sharing/access.test.ts +162 -0
- package/packages/arcgis-rest-portal/test/sharing/helpers.test.ts +55 -0
- package/packages/arcgis-rest-portal/test/sharing/share-item-with-group.test.ts +1328 -0
- package/packages/arcgis-rest-portal/test/sharing/unshare-item-with-group.test.ts +288 -0
- package/packages/arcgis-rest-portal/test/users/get-user-tags.test.ts +71 -0
- package/packages/arcgis-rest-portal/test/users/get-user-url.test.ts +40 -0
- package/packages/arcgis-rest-portal/test/users/get-user.test.ts +90 -0
- package/packages/arcgis-rest-portal/test/users/invitation.test.ts +126 -0
- package/packages/arcgis-rest-portal/test/users/notification.test.ts +76 -0
- package/packages/arcgis-rest-portal/test/users/search.test.ts +41 -0
- package/packages/arcgis-rest-portal/test/users/update.test.ts +150 -0
- package/packages/arcgis-rest-portal/test/util/SearchQueryBuilder.test.ts +295 -0
- package/packages/arcgis-rest-portal/test/util/array.test.ts +33 -0
- package/packages/arcgis-rest-portal/test/util/get-portal-settings.test.ts +57 -0
- package/packages/arcgis-rest-portal/test/util/get-portal-url.test.ts +37 -0
- package/packages/arcgis-rest-portal/test/util/portal.test.ts +137 -0
- package/packages/arcgis-rest-portal/test/util/scrub-control-chars.test.ts +25 -0
- package/packages/arcgis-rest-portal/tsconfig.json +6 -0
- package/packages/arcgis-rest-request/README.md +72 -0
- package/packages/arcgis-rest-request/package.json +69 -0
- package/packages/arcgis-rest-request/post-message-auth-spec.md +70 -0
- package/packages/arcgis-rest-request/src/ApiKeyManager.ts +60 -0
- package/packages/arcgis-rest-request/src/ApplicationCredentialsManager.ts +141 -0
- package/packages/arcgis-rest-request/src/ArcGISIdentityManager.ts +1470 -0
- package/packages/arcgis-rest-request/src/app-tokens.ts +132 -0
- package/packages/arcgis-rest-request/src/authenticated-request-options.ts +23 -0
- package/packages/arcgis-rest-request/src/federation-utils.ts +88 -0
- package/packages/arcgis-rest-request/src/fetch-token.ts +48 -0
- package/packages/arcgis-rest-request/src/generate-token.ts +32 -0
- package/packages/arcgis-rest-request/src/index.ts +46 -0
- package/packages/arcgis-rest-request/src/request.ts +446 -0
- package/packages/arcgis-rest-request/src/revoke-token.ts +73 -0
- package/packages/arcgis-rest-request/src/types/feature.ts +42 -0
- package/packages/arcgis-rest-request/src/types/geometry.ts +239 -0
- package/packages/arcgis-rest-request/src/types/group.ts +72 -0
- package/packages/arcgis-rest-request/src/types/service.ts +87 -0
- package/packages/arcgis-rest-request/src/types/symbol.ts +21 -0
- package/packages/arcgis-rest-request/src/types/user.ts +49 -0
- package/packages/arcgis-rest-request/src/utils/ArcGISRequestError.ts +82 -0
- package/packages/arcgis-rest-request/src/utils/ErrorTypes.ts +29 -0
- package/packages/arcgis-rest-request/src/utils/GrantTypes.ts +5 -0
- package/packages/arcgis-rest-request/src/utils/HTTPMethods.ts +6 -0
- package/packages/arcgis-rest-request/src/utils/IAuthenticationManager.ts +22 -0
- package/packages/arcgis-rest-request/src/utils/IFetchTokenParams.ts +11 -0
- package/packages/arcgis-rest-request/src/utils/IGenerateTokenParams.ts +9 -0
- package/packages/arcgis-rest-request/src/utils/IParamBuilder.ts +3 -0
- package/packages/arcgis-rest-request/src/utils/IParams.ts +6 -0
- package/packages/arcgis-rest-request/src/utils/IParamsBuilder.ts +5 -0
- package/packages/arcgis-rest-request/src/utils/IRequestOptions.ts +59 -0
- package/packages/arcgis-rest-request/src/utils/ITokenRequestOptions.ts +9 -0
- package/packages/arcgis-rest-request/src/utils/ResponseFormats.ts +10 -0
- package/packages/arcgis-rest-request/src/utils/append-custom-params.ts +46 -0
- package/packages/arcgis-rest-request/src/utils/clean-url.ts +20 -0
- package/packages/arcgis-rest-request/src/utils/decode-query-string.ts +27 -0
- package/packages/arcgis-rest-request/src/utils/encode-form-data.ts +41 -0
- package/packages/arcgis-rest-request/src/utils/encode-query-string.ts +37 -0
- package/packages/arcgis-rest-request/src/utils/process-params.ts +109 -0
- package/packages/arcgis-rest-request/src/utils/retryAuthError.ts +10 -0
- package/packages/arcgis-rest-request/src/utils/warn.ts +11 -0
- package/packages/arcgis-rest-request/src/utils/with-options.ts +48 -0
- package/packages/arcgis-rest-request/src/validate-app-access.ts +69 -0
- package/packages/arcgis-rest-request/test/ApiKey.test.ts +53 -0
- package/packages/arcgis-rest-request/test/ApplicationSession.test.ts +148 -0
- package/packages/arcgis-rest-request/test/ArcGISIdentityManager.test.ts +2579 -0
- package/packages/arcgis-rest-request/test/app-tokens.test.ts +91 -0
- package/packages/arcgis-rest-request/test/federation-utils.test.ts +323 -0
- package/packages/arcgis-rest-request/test/fetchToken.test.ts +110 -0
- package/packages/arcgis-rest-request/test/generateToken.test.ts +40 -0
- package/packages/arcgis-rest-request/test/mocks/errors.ts +76 -0
- package/packages/arcgis-rest-request/test/mocks/geojson-feature-collection.ts +13 -0
- package/packages/arcgis-rest-request/test/mocks/param-builder.ts +7 -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 +563 -0
- package/packages/arcgis-rest-request/test/revoke-token.test.ts +55 -0
- package/packages/arcgis-rest-request/test/utils/ArcGISAuthError.test.ts +196 -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/clean-url.test.ts +50 -0
- package/packages/arcgis-rest-request/test/utils/encode-form-data.test.ts +146 -0
- package/packages/arcgis-rest-request/test/utils/encode-query-string.test.ts +22 -0
- package/packages/arcgis-rest-request/test/utils/process-params.test.ts +205 -0
- package/packages/arcgis-rest-request/test/utils/with-options.test.ts +135 -0
- package/packages/arcgis-rest-request/test/validate-app-access.test.ts +44 -0
- package/packages/arcgis-rest-request/tsconfig.json +4 -0
- package/packages/arcgis-rest-routing/README.md +74 -0
- package/packages/arcgis-rest-routing/package.json +69 -0
- package/packages/arcgis-rest-routing/src/closestFacility.ts +223 -0
- package/packages/arcgis-rest-routing/src/helpers.ts +104 -0
- package/packages/arcgis-rest-routing/src/index.ts +20 -0
- package/packages/arcgis-rest-routing/src/originDestinationMatrix.ts +219 -0
- package/packages/arcgis-rest-routing/src/serviceArea.ts +169 -0
- package/packages/arcgis-rest-routing/src/solveRoute.ts +179 -0
- package/packages/arcgis-rest-routing/test/closestFacility.test.ts +686 -0
- package/packages/arcgis-rest-routing/test/mocks/inputs.ts +132 -0
- package/packages/arcgis-rest-routing/test/mocks/responses.ts +13316 -0
- package/packages/arcgis-rest-routing/test/originDestinationMatrix.test.ts +795 -0
- package/packages/arcgis-rest-routing/test/serviceArea.test.ts +601 -0
- package/packages/arcgis-rest-routing/test/solveRoute.test.ts +681 -0
- package/packages/arcgis-rest-routing/tsconfig.json +6 -0
- package/prettier-package-json.config.cjs +81 -0
- package/rollup.js +152 -0
- package/scripts/create-dist-package-jsons.js +17 -0
- package/scripts/deploy-doc-site.js +16 -0
- package/scripts/generate-sri-hashes.js +52 -0
- package/scripts/get-package-json.js +27 -0
- package/scripts/run-demo-server.js +21 -0
- package/scripts/test-helpers.ts +20 -0
- package/tsconfig.json +62 -0
- package/typedoc.json +14 -0
@@ -0,0 +1,600 @@
|
|
1
|
+
{% macro @type(type, isArray, isRest) -%}
|
2
|
+
{%- if type.type === 'stringLiteral' -%}
|
3
|
+
<span class="text-green">"{{type.value}}"</span>
|
4
|
+
{%- endif -%}
|
5
|
+
|
6
|
+
{%- if type.declaration and type.declaration.children -%}
|
7
|
+
{<dl class="type-child-list clearfix">
|
8
|
+
{%- for child in type.declaration.children -%}
|
9
|
+
<dt class="type-child-name">{{child.name}}:</dt><dd class="type-child-type">{{ @type(child.type) }}</dd>
|
10
|
+
{%- endfor -%}
|
11
|
+
</dl>}
|
12
|
+
{%- endif -%}
|
13
|
+
|
14
|
+
{%- if type.type === 'array' and (type.elementType.type === "union" or (type.elementType.type === "typeParameter" and type.elementType.constraint.type === "union")) -%}
|
15
|
+
<i class="no-wrap">{{ @type(type.elementType, true) }}</i>
|
16
|
+
{%- elif type.type === 'array' -%}
|
17
|
+
<i class="no-wrap">{{ @type(type.elementType) }}<span class="text-light-gray">{{ '[]' }}</span></i>
|
18
|
+
{%- endif -%}
|
19
|
+
|
20
|
+
{%- if type.type === 'array' -%}
|
21
|
+
<span class="text-light-gray">{{ ' | ' }}</span>{{ @type(type.elementType) }}
|
22
|
+
{%- endif -%}
|
23
|
+
|
24
|
+
{%- if type.type === 'intrinsic' -%}
|
25
|
+
<i class="text-purple">{{type.name}}</i>
|
26
|
+
{%- endif -%}
|
27
|
+
|
28
|
+
{%- if type.type === 'reference' and type.id and API_TOOLS.findById(data.typedoc, type.id) -%}
|
29
|
+
<i><a href="{{ API_TOOLS.findById(data.typedoc, type.id).pageUrl }}">{{type.name}}</a></i>
|
30
|
+
{%- elif API_TOOLS.findByName(data.typedoc, type.name) -%}
|
31
|
+
<i><a href="{{ API_TOOLS.findByName(data.typedoc, type.name).pageUrl }}">{{type.name}}</a></i>
|
32
|
+
{%- elif type.type === 'reference' -%}
|
33
|
+
<i>{{type.name}}</i>
|
34
|
+
{%- endif -%}
|
35
|
+
|
36
|
+
{%- if type.type === 'reflection' and type.declaration.signatures.length > 0 -%}
|
37
|
+
<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>
|
38
|
+
{%- elif type.type === 'reflection' and type.declaration.id and API_TOOLS.findById(data.typedoc, type.declaration.id) -%}
|
39
|
+
{% set declaration = API_TOOLS.findById(data.typedoc, type.declaration.id) %}
|
40
|
+
<i><a href="{{ declaration.pageUrl }}">{{declaration.name}}</a></i>
|
41
|
+
{%- elif type.type === 'reflection' and type.declaration and type.declaration.indexSignature -%}
|
42
|
+
{% for signature in type.declaration.indexSignature %}
|
43
|
+
<i class="no-wrap">{% for param in signature.parameters%}[key: {{@type(param.type)}}]: {% endfor %}{{@type(signature.type)}}</i>
|
44
|
+
{% endfor %}
|
45
|
+
{%- elif type.type === 'reflection' -%}
|
46
|
+
<i>{{ type.name }}</i>
|
47
|
+
{%- endif -%}
|
48
|
+
|
49
|
+
{%- if type.type === 'union' -%}
|
50
|
+
<i>{%- for t in type.types -%}
|
51
|
+
{{ @type(t) }}{% if isArray %}<span class="text-light-gray">{{ '[]' }}</span>{% endif %}
|
52
|
+
|
53
|
+
{%- if (loop.last === false) -%}
|
54
|
+
<span class="text-light-gray">{{ ' | ' }}</span>
|
55
|
+
{%- endif -%}
|
56
|
+
{%- endfor -%}</i>
|
57
|
+
{%- endif -%}
|
58
|
+
|
59
|
+
{%- if type.type === 'tuple' -%}
|
60
|
+
<i class="no-wrap">{%- for t in type.elements -%}
|
61
|
+
{%- if (loop.first) -%}
|
62
|
+
<span class="text-light-gray">{{ '[' }}</span>
|
63
|
+
{%- endif -%}
|
64
|
+
{{ @type(t) }}
|
65
|
+
{%- if (loop.last === false) -%}
|
66
|
+
<span class="text-light-gray">{{ ', ' }}</span>
|
67
|
+
{%- endif -%}
|
68
|
+
{%- if (loop.last) -%}
|
69
|
+
<span class="text-light-gray">{{ ']' }}</span>
|
70
|
+
{%- endif -%}
|
71
|
+
{%- endfor -%}</i>
|
72
|
+
{%- endif -%}
|
73
|
+
|
74
|
+
{%- if type.type === 'typeParameter' and type.constraint -%}
|
75
|
+
{{ @type(type.constraint, isArray) }}
|
76
|
+
{%- endif -%}
|
77
|
+
|
78
|
+
{%- if type.typeArguments -%}
|
79
|
+
<i>{% for arg in type.typeArguments -%}
|
80
|
+
{%- if (loop.first) -%}<span class="text-light-gray">{{ '<' }}</span>{%- endif -%}
|
81
|
+
{{ @type(arg) }}
|
82
|
+
{%- if (loop.last) -%}<span class="text-light-gray">{{ '>' }}</span>{%- endif -%}
|
83
|
+
{%- endfor %}</i>
|
84
|
+
{%- endif -%}
|
85
|
+
{%- endmacro %}
|
86
|
+
|
87
|
+
{% macro @param(param) -%}
|
88
|
+
{%- if param -%}
|
89
|
+
{{param.name}}: {{@type(param.type, undefined, param.flags.isRest)}}
|
90
|
+
{%- endif -%}
|
91
|
+
{%- endmacro %}
|
92
|
+
|
93
|
+
{% macro @signatureParams(params) -%}
|
94
|
+
{% for param in params | stripThisFromParams -%}{{ @param(param) }}{{ ', ' if (loop.last === false)}}{%- endfor %}
|
95
|
+
{%- endmacro %}
|
96
|
+
|
97
|
+
{% macro @signature(signature) -%}
|
98
|
+
<li class="code-face tsd-signature tsd-kind-icon trailer-0 leader-0">{{ signature.name }}<span class="text-light-gray">(</span>{{ @signatureParams(signature.parameters) }}<span class="text-light-gray">) : </span>{{@type(signature.type)}}</li>
|
99
|
+
{%- endmacro %}
|
100
|
+
|
101
|
+
{% macro @inherited(inheritedFrom) -%}
|
102
|
+
{% if inheritedFrom %}
|
103
|
+
<span class="label">Inherited</span>
|
104
|
+
{% endif %}
|
105
|
+
{%- endmacro %}
|
106
|
+
|
107
|
+
{% macro @propertyTableForId (id, header, column1Header, column2Header)%}
|
108
|
+
{% if header %}
|
109
|
+
<h2 class="font-size-1 trailer-half">{{header | safe}}</h2>
|
110
|
+
{% endif %}
|
111
|
+
<div class="overflow-auto trailer-1">
|
112
|
+
<table class="table">
|
113
|
+
<thead>
|
114
|
+
<tr>
|
115
|
+
<th>{{column1Header}}</th>
|
116
|
+
<th>{{column2Header}}</th>
|
117
|
+
<th>Notes</th>
|
118
|
+
</tr>
|
119
|
+
</thead>
|
120
|
+
<tbody>
|
121
|
+
{% for child in API_TOOLS.findById(data.typedoc, id).children %}
|
122
|
+
<tr id="{{child.name}}">
|
123
|
+
<td class="code-face {{child.icon}} no-wrap">
|
124
|
+
<a href="#{{child.name}}" class="table-link">
|
125
|
+
<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>
|
126
|
+
</a>
|
127
|
+
<span class="tsd-kind-icon">{{child.name}}</span>
|
128
|
+
{{ @flags(child.flags) }}
|
129
|
+
{{ @inherited(child.inheritedFrom) }}
|
130
|
+
</td>
|
131
|
+
<td class="code-face">
|
132
|
+
{% if child.defaultValue %}
|
133
|
+
{{ child.defaultValue }}
|
134
|
+
{% elif child.getSignature %}
|
135
|
+
{{ @type(child.getSignature[0].type) }}
|
136
|
+
{% else %}
|
137
|
+
{{ @type(child.type) }}
|
138
|
+
{% endif %}
|
139
|
+
</td>
|
140
|
+
<td class="body-face api-param-comment">
|
141
|
+
{% markdown -%}
|
142
|
+
{{ child.comment.shortText | safe | trim }}
|
143
|
+
{%- endmarkdown %}
|
144
|
+
</td>
|
145
|
+
</tr>
|
146
|
+
{% endfor %}
|
147
|
+
|
148
|
+
</tbody>
|
149
|
+
</table>
|
150
|
+
</div>
|
151
|
+
{% endmacro %}
|
152
|
+
|
153
|
+
{% macro @properties (group, children) %}
|
154
|
+
<div class="overflow-auto trailer-1">
|
155
|
+
<table class="table">
|
156
|
+
<thead>
|
157
|
+
<tr>
|
158
|
+
<th>{{ API_TOOLS.findChildById(group.children[0], children).kindString }}</th>
|
159
|
+
<th>{{ 'Value' if API_TOOLS.findChildById(group.children[0], children).defaultValue else 'Type' }}</th>
|
160
|
+
<th>Notes</th>
|
161
|
+
</tr>
|
162
|
+
</thead>
|
163
|
+
<tbody>
|
164
|
+
{% for id in group.children %}
|
165
|
+
{% set child = API_TOOLS.findChildById(id, children) %}
|
166
|
+
<tr id="{{child.name}}">
|
167
|
+
<td class="code-face {{child.icon}} no-wrap">
|
168
|
+
<a href="#{{child.name}}" class="table-link">
|
169
|
+
<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>
|
170
|
+
</a>
|
171
|
+
<span class="tsd-kind-icon">{{child.name}}</span>
|
172
|
+
{{ @flags(child.flags) }}
|
173
|
+
{{ @inherited(child.inheritedFrom) }}
|
174
|
+
</td>
|
175
|
+
<td class="code-face">
|
176
|
+
{% if child.defaultValue %}
|
177
|
+
{{ child.defaultValue }}
|
178
|
+
{% elif child.getSignature %}
|
179
|
+
{{ @type(child.getSignature[0].type) }}
|
180
|
+
{% else %}
|
181
|
+
{{ @type(child.type) }}
|
182
|
+
{% endif %}
|
183
|
+
</td>
|
184
|
+
<td class="body-face api-param-comment">
|
185
|
+
{% markdown -%}
|
186
|
+
{{ child.comment.shortText | safe | trim }}
|
187
|
+
{%- endmarkdown %}
|
188
|
+
</td>
|
189
|
+
</tr>
|
190
|
+
{% endfor %}
|
191
|
+
|
192
|
+
</tbody>
|
193
|
+
</table>
|
194
|
+
</div>
|
195
|
+
{% endmacro %}
|
196
|
+
|
197
|
+
{% macro @indexSignature (signatures, parentKind) %}
|
198
|
+
<div class="overflow-auto trailer-1">
|
199
|
+
<table class="table">
|
200
|
+
<thead>
|
201
|
+
<tr>
|
202
|
+
<th>Key Type</th>
|
203
|
+
<th>Value Type</th>
|
204
|
+
<th>Notes</th>
|
205
|
+
</tr>
|
206
|
+
</thead>
|
207
|
+
<tbody>
|
208
|
+
{% for child in signatures %}
|
209
|
+
<tr id="{{child.parameters[0].id}}">
|
210
|
+
<td class="code-face tsd-kind-index-signature tsd-parent-kind-{{parentKind | lower}} no-wrap">
|
211
|
+
<a href="#{{child.parameters[0].id}}" class="table-link">
|
212
|
+
<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>
|
213
|
+
</a>
|
214
|
+
<span class="tsd-kind-icon">{{ @type(child.parameters[0].type) }}</span>
|
215
|
+
</td>
|
216
|
+
<td class="code-face">
|
217
|
+
{% if child.defaultValue %}
|
218
|
+
{{ child.defaultValue }}
|
219
|
+
{% elif child.getSignature %}
|
220
|
+
{{ @type(child.getSignature[0].type) }}
|
221
|
+
{% else %}
|
222
|
+
{{ @type(child.type) }}
|
223
|
+
{% endif %}
|
224
|
+
</td>
|
225
|
+
<td class="body-face api-param-comment">
|
226
|
+
{% markdown -%}
|
227
|
+
{{ child.comment.shortText | safe | trim }}
|
228
|
+
{%- endmarkdown %}
|
229
|
+
</td>
|
230
|
+
</tr>
|
231
|
+
{% endfor %}
|
232
|
+
|
233
|
+
</tbody>
|
234
|
+
</table>
|
235
|
+
</div>
|
236
|
+
{% endmacro %}
|
237
|
+
|
238
|
+
{% macro @flags(flags) %}
|
239
|
+
{% if flags.isOptional %}
|
240
|
+
<span class="label">Optional</span>
|
241
|
+
{% endif %}
|
242
|
+
|
243
|
+
{% if flags.isPrivate %}
|
244
|
+
<span class="label">Private</span>
|
245
|
+
{% endif %}
|
246
|
+
|
247
|
+
{% if flags.isProtected %}
|
248
|
+
<span class="label">Protected</span>
|
249
|
+
{% endif %}
|
250
|
+
|
251
|
+
{% if flags.isRequired %}
|
252
|
+
<span class="label">Required</span>
|
253
|
+
{% endif %}
|
254
|
+
|
255
|
+
{% if flags.isStatic %}
|
256
|
+
<span class="label">Static</span>
|
257
|
+
{% endif %}
|
258
|
+
{% endmacro %}
|
259
|
+
|
260
|
+
{% macro @signatures(signatures) %}
|
261
|
+
{%- if signatures[0].comment.shortText -%}
|
262
|
+
{% markdown -%}
|
263
|
+
{{ signatures[0].comment.shortText | safe }}
|
264
|
+
{%- endmarkdown %}
|
265
|
+
{%- endif %}
|
266
|
+
|
267
|
+
{% if signatures[0].comment.text %}
|
268
|
+
{% markdown -%}
|
269
|
+
{{ signatures[0].comment.text | safe }}
|
270
|
+
{%- endmarkdown %}
|
271
|
+
{% endif %}
|
272
|
+
|
273
|
+
<div class="panel padding-leader-half padding-trailer-half padding-right-quarter padding-left-half trailer-half">
|
274
|
+
<ul class="list-plain tsd-signatures {{icon}} trailer-0 leader-0">
|
275
|
+
{% for signature in signatures %}
|
276
|
+
{{ @signature(signature) }}
|
277
|
+
{% endfor %}
|
278
|
+
</ul>
|
279
|
+
</div>
|
280
|
+
|
281
|
+
{% if signatures[0].parameters %}
|
282
|
+
<h2 class="font-size-1 trailer-half">Parameters</h2>
|
283
|
+
{{@parametersTable(signatures[0].parameters, signatures[0].name)}}
|
284
|
+
{% endif %}
|
285
|
+
|
286
|
+
{% for param in signatures[0].parameters %}
|
287
|
+
{% if param.name == "requestOptions" and param.type.type === "reference" %}
|
288
|
+
{% set id = API_TOOLS.findByName(data.typedoc, param.type.name).id %}
|
289
|
+
{{ @propertyTableForId(id, "Available <code>requestOptions</code>", "Property", "Type")}}
|
290
|
+
{% endif %}
|
291
|
+
|
292
|
+
{% if param.name == "requestOptions" and param.type.type !== "reference" and param.type.id %}
|
293
|
+
{{ @propertyTableForId(param.type.id, "Options", "Property", "Type")}}
|
294
|
+
{% endif %}
|
295
|
+
{% endfor %}
|
296
|
+
|
297
|
+
<h2 class="font-size-1 trailer-half">Returns</h2>
|
298
|
+
|
299
|
+
{%- markdown -%}
|
300
|
+
{{ signatures[0].comment.returns | safe }}
|
301
|
+
{%- endmarkdown %}
|
302
|
+
|
303
|
+
<div class="fonts-size--1 panel padding-leader-half padding-trailer-half padding-right-half padding-left-half trailer-half">
|
304
|
+
{{@type(signatures[0].type)}}
|
305
|
+
</div>
|
306
|
+
|
307
|
+
{% if (signatures[0].type.name === "Promise" and signatures[0].type.typeArguments[0].type === "reference") %}
|
308
|
+
{% set id = API_TOOLS.findByName(data.typedoc, signatures[0].type.typeArguments[0].name).id %}
|
309
|
+
{{ @propertyTableForId(id, undefined, "Property", "Type") }}
|
310
|
+
{% elif (signatures[0].type.name === "Promise" and signatures[0].type.typeArguments[0].id) or signatures[0].type.id %}
|
311
|
+
{% set id = signatures[0].type.typeArguments[0].id or signatures[0].type.id %}
|
312
|
+
{{ @propertyTableForId(id, undefined, "Property", "Type") }}
|
313
|
+
{% endif %}
|
314
|
+
{% endmacro %}
|
315
|
+
|
316
|
+
{% macro @methodsTable(group, children) %}
|
317
|
+
<div class="overflow-auto trailer-1">
|
318
|
+
<table class="table">
|
319
|
+
<thead>
|
320
|
+
<tr>
|
321
|
+
<th>Method</th>
|
322
|
+
<th>Returns</th>
|
323
|
+
<th>Notes</th>
|
324
|
+
</tr>
|
325
|
+
</thead>
|
326
|
+
<tbody>
|
327
|
+
{% for childId in group.children %}
|
328
|
+
{% set child = API_TOOLS.findChildById(childId, children) %}
|
329
|
+
<tr id="{{child.signatures[0].name}}-summary">
|
330
|
+
<td>
|
331
|
+
<a href="#{{child.signatures[0].name}}-summary" class="table-link">
|
332
|
+
<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>
|
333
|
+
</a>
|
334
|
+
<ul class="method-table-signatures {{child.signatures[0].icon}}">
|
335
|
+
{% for signature in child.signatures -%}
|
336
|
+
<li class="code-face tsd-signature tsd-kind-icon">
|
337
|
+
<a href="#{{signature.name}}">{{ signature.name }}</a><span class="text-light-gray">(</span>{{ @signatureParams(signature.parameters) }}<span class="text-light-gray">)</span>
|
338
|
+
</li>
|
339
|
+
{%- endfor %}
|
340
|
+
</ul>
|
341
|
+
</td>
|
342
|
+
<td class="code-face">{{@type(child.signatures[0].type)}}</td>
|
343
|
+
<td class="body-face api-param-comment">
|
344
|
+
{% markdown -%}
|
345
|
+
{{ child.signatures[0].comment.shortText | safe | trim }}
|
346
|
+
{%- endmarkdown %}
|
347
|
+
{% markdown -%}
|
348
|
+
{{ child.signatures[0].comment.text | safe | trim }}
|
349
|
+
{%- endmarkdown %}
|
350
|
+
</td>
|
351
|
+
</tr>
|
352
|
+
{% endfor %}
|
353
|
+
</tbody>
|
354
|
+
</table>
|
355
|
+
</div>
|
356
|
+
|
357
|
+
{% for childId in group.children %}
|
358
|
+
{% set child = API_TOOLS.findChildById(childId, children) %}
|
359
|
+
{% set signatures = child.signatures %}
|
360
|
+
<div id="{{signatures[0].name}}" class="method-panel panel panel-white padding-trailer-0 leader-1 trailer-1">
|
361
|
+
<header class="clearfix">
|
362
|
+
<a href="#{{signatures[0].name}}" class="table-link">
|
363
|
+
<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>
|
364
|
+
</a>
|
365
|
+
<h3 class="font-size-2 code-face trailer-0 margin-right-half left">{{signatures[0].name}}</h3>
|
366
|
+
{{ @flags(child.flags)}}
|
367
|
+
<small class="{{signatures[0].icon}} font-size--2 right">
|
368
|
+
<span class="tsd-kind-icon">
|
369
|
+
{% if child.flags.isStatic %}
|
370
|
+
Static {{kindString}} Method
|
371
|
+
{% elif child.flags.isPrivate %}
|
372
|
+
Private {{kindString}} Method
|
373
|
+
{% elif child.flags.isProtected %}
|
374
|
+
Protected {{kindString}} Method
|
375
|
+
{% else %}
|
376
|
+
{{kindString}} Method
|
377
|
+
{% endif %}
|
378
|
+
</span>
|
379
|
+
</small>
|
380
|
+
</header>
|
381
|
+
|
382
|
+
<hr class="leader-half trailer-half">
|
383
|
+
|
384
|
+
<div class="api-function-comment">
|
385
|
+
{% markdown -%}
|
386
|
+
{{ signatures[0].comment.shortText | safe }}
|
387
|
+
{%- endmarkdown %}
|
388
|
+
</div>
|
389
|
+
|
390
|
+
<div class="fonts-size--1 panel padding-leader-half padding-trailer-half padding-right-half padding-left-half trailer-half">
|
391
|
+
<ul class="list-plain trailer-0 tsd-signatures trailer-half {{signatures[0].icon}}">
|
392
|
+
{% for signature in signatures %}
|
393
|
+
{{ @signature(signature) }}
|
394
|
+
{% endfor %}
|
395
|
+
</ul>
|
396
|
+
</div>
|
397
|
+
|
398
|
+
{% if (signatures[0].parameters | stripThisFromParams).length > 0 %}
|
399
|
+
<h2 class="font-size-1 trailer-half">Parameters</h2>
|
400
|
+
{{@parametersTable(signatures[0].parameters, signatures[0].name)}}
|
401
|
+
{% endif %}
|
402
|
+
|
403
|
+
<h2 class="font-size-1 trailer-half">Returns</h2>
|
404
|
+
|
405
|
+
{%- markdown -%}
|
406
|
+
{{ signatures[0].comment.returns | safe }}
|
407
|
+
{%- endmarkdown %}
|
408
|
+
|
409
|
+
<div class="fonts-size--1 panel padding-leader-half padding-trailer-half padding-right-half padding-left-half trailer-half">
|
410
|
+
{{@type(signatures[0].type)}}
|
411
|
+
</div>
|
412
|
+
|
413
|
+
{% if signatures[0].comment.text %}
|
414
|
+
<hr class="leader-half trailer-half">
|
415
|
+
|
416
|
+
{% markdown -%}
|
417
|
+
{{ signatures[0].comment.text | safe }}
|
418
|
+
{%- endmarkdown %}
|
419
|
+
{% endif %}
|
420
|
+
</div>
|
421
|
+
{% endfor %}
|
422
|
+
{% endmacro %}
|
423
|
+
|
424
|
+
{% macro @accessorsTable(group, children) %}
|
425
|
+
{{ @properties(group, children) }}
|
426
|
+
{# @TODO make a custom table when and if we need setters... #}
|
427
|
+
{% endmacro %}
|
428
|
+
|
429
|
+
{% macro @parametersTable(parameters, fnName) %}
|
430
|
+
<div class="overflow-auto trailer-1">
|
431
|
+
<table class="table">
|
432
|
+
<thead>
|
433
|
+
<tr>
|
434
|
+
<th class="font-size--2">Parameter</th>
|
435
|
+
<th class="font-size--2">Type</th>
|
436
|
+
<th class="font-size--2">Default</th>
|
437
|
+
<th class="font-size--2">Notes</th>
|
438
|
+
</tr>
|
439
|
+
</thead>
|
440
|
+
<tbody>
|
441
|
+
{% for param in parameters | stripThisFromParams -%}
|
442
|
+
<tr id="{{fnName}}-{{param.name}}">
|
443
|
+
<td class="code-face">
|
444
|
+
<a href="#{{fnName}}-{{param.name}}" class="table-link">
|
445
|
+
<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>
|
446
|
+
</a>
|
447
|
+
<span class="code-face">{{param.name}}</span>
|
448
|
+
{% if param.defaultValue %}
|
449
|
+
{{ @flags({isOptional: true}) }}
|
450
|
+
{% elif not param.defaultValue and not param.flags.isOptional %}
|
451
|
+
{{ @flags({isRequired: true}) }}
|
452
|
+
{% else %}
|
453
|
+
{{ @flags(param.flags) }}
|
454
|
+
{% endif %}
|
455
|
+
</td>
|
456
|
+
<td class="code-face">{{@type(param.type)}}</td>
|
457
|
+
<td class="code-face">{{param.defaultValue}}</td>
|
458
|
+
<td class="body-face api-param-comment">
|
459
|
+
{% markdown -%}
|
460
|
+
{{ param.comment.shortText | safe | trim }}
|
461
|
+
{%- endmarkdown %}
|
462
|
+
{% markdown -%}
|
463
|
+
{{ param.comment.text | safe | trim }}
|
464
|
+
{%- endmarkdown %}
|
465
|
+
</td>
|
466
|
+
</tr>
|
467
|
+
{%- endfor %}
|
468
|
+
</tbody>
|
469
|
+
</table>
|
470
|
+
</div>
|
471
|
+
{% endmacro %}
|
472
|
+
|
473
|
+
<div class="clearfix trailer-half">
|
474
|
+
<h1 class="left font-size-5 code-face trailer-0">{{name}}</h1>
|
475
|
+
<small class="{{icon}} font-size--2 right leader-half margin-right-half"><span class="tsd-kind-icon">{{kindString}}</span></small>
|
476
|
+
</div>
|
477
|
+
|
478
|
+
{% if comment %}
|
479
|
+
{% markdown -%}
|
480
|
+
{{ comment.shortText | safe }}
|
481
|
+
{%- endmarkdown %}
|
482
|
+
{% endif %}
|
483
|
+
|
484
|
+
{% if comment and comment.text %}
|
485
|
+
{% markdown -%}
|
486
|
+
{{ comment.text | safe }}
|
487
|
+
{%- endmarkdown %}
|
488
|
+
{% endif %}
|
489
|
+
|
490
|
+
{% if implementedTypes %}
|
491
|
+
<h2>Implements</h2>
|
492
|
+
<ul class="list-plain trailer-1">
|
493
|
+
{% for implementedType in implementedTypes %}
|
494
|
+
{% if implementedType.id %}
|
495
|
+
{% set base = API_TOOLS.findById(data.typedoc, implementedType.id) %}
|
496
|
+
<li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
|
497
|
+
{% elif implementedType.name %}
|
498
|
+
{% set base = API_TOOLS.findByName(data.typedoc, implementedType.name) %}
|
499
|
+
{% if base %}
|
500
|
+
<li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
|
501
|
+
{% elif implementedType.name %}
|
502
|
+
<li class="code-face">{{base.name}}</li>
|
503
|
+
{% endif %}
|
504
|
+
{% endif %}
|
505
|
+
{% endfor %}
|
506
|
+
</ul>
|
507
|
+
{% endif %}
|
508
|
+
|
509
|
+
{% if extendedTypes %}
|
510
|
+
<h2>Extends</h2>
|
511
|
+
<ul class="list-plain trailer-1">
|
512
|
+
{% for extendedType in extendedTypes %}
|
513
|
+
{% if extendedType.id %}
|
514
|
+
{% set base = API_TOOLS.findById(data.typedoc, extendedType.id) %}
|
515
|
+
<li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
|
516
|
+
{% elif extendedType.name %}
|
517
|
+
{% set base = API_TOOLS.findByName(data.typedoc, extendedType.name) %}
|
518
|
+
{% if base %}
|
519
|
+
<li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
|
520
|
+
{% elif extendedType.name %}
|
521
|
+
<li class="code-face">{{base.name}}</li>
|
522
|
+
{% endif %}
|
523
|
+
{% endif %}
|
524
|
+
{% endfor %}
|
525
|
+
</ul>
|
526
|
+
{% endif %}
|
527
|
+
|
528
|
+
{% if type %}
|
529
|
+
Value(s):
|
530
|
+
<pre style="display: inline;">{{@type(type)}}</pre>
|
531
|
+
{% endif %}
|
532
|
+
|
533
|
+
{% if groups %}
|
534
|
+
{% for group in groups %}
|
535
|
+
<h2 class="font-size-3">{{group.title}}</h2>
|
536
|
+
|
537
|
+
{% if group.title == 'Enumeration members' %}
|
538
|
+
{{ @properties(group, children) }}
|
539
|
+
{% endif %}
|
540
|
+
|
541
|
+
{% if group.title == 'Properties' %}
|
542
|
+
{{ @properties(group, children) }}
|
543
|
+
{% endif %}
|
544
|
+
|
545
|
+
{% if group.title == 'Constructors' %}
|
546
|
+
{% set firstSignature = API_TOOLS.findChildById(group.children[0], children).signatures[0] %}
|
547
|
+
<div class="fonts-size--1 panel padding-leader-half padding-trailer-half padding-right-half padding-left-half trailer-half">
|
548
|
+
<ul class="list-plain trailer-0 {{ API_TOOLS.findChildById(group.children[0], children).icon }}">
|
549
|
+
{% for id in group.children %}
|
550
|
+
{% set signatures = API_TOOLS.findChildById(id, children).signatures %}
|
551
|
+
{% for signature in signatures %}
|
552
|
+
{{ @signature(signature) }}
|
553
|
+
{% endfor %}
|
554
|
+
{% endfor %}
|
555
|
+
</ul>
|
556
|
+
</div>
|
557
|
+
|
558
|
+
<h2 class="font-size-1">Constructor Parameters</h2>
|
559
|
+
{{@parametersTable(firstSignature.parameters, 'Constructor')}}
|
560
|
+
{% endif %}
|
561
|
+
|
562
|
+
{% if group.title == 'Accessors' %}
|
563
|
+
{{ @accessorsTable(group, children) }}
|
564
|
+
{% endif %}
|
565
|
+
|
566
|
+
{% if group.title == 'Methods' %}
|
567
|
+
{{ @methodsTable(group, children) }}
|
568
|
+
{% endif %}
|
569
|
+
|
570
|
+
{% endfor %}
|
571
|
+
{% endif %}
|
572
|
+
|
573
|
+
{% if indexSignature %}
|
574
|
+
<h3>Index Signatures</h3>
|
575
|
+
{{@indexSignature(indexSignature, kindString)}}
|
576
|
+
{% endif %}
|
577
|
+
|
578
|
+
{% if signatures %}
|
579
|
+
{{@signatures(signatures)}}
|
580
|
+
{% endif %}
|
581
|
+
|
582
|
+
<hr class="leader-half trailer-half">
|
583
|
+
|
584
|
+
{% if signatures[0].comment.tags %}
|
585
|
+
{% for tag in signatures[0].comment.tags %}
|
586
|
+
{% if tag.tag === "restlink" %}
|
587
|
+
<small class="font-size--2">REST API documentation for <code>{{name}}()</code> available at <a href="{{tag.text}}">{{tag.text}}</a></small>
|
588
|
+
<br>
|
589
|
+
{% endif %}
|
590
|
+
{% endfor %}
|
591
|
+
{% endif %}
|
592
|
+
|
593
|
+
<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>
|
594
|
+
|
595
|
+
{% if isDev %}
|
596
|
+
<details class="leader-1">
|
597
|
+
<summary>Debug Info</summary>
|
598
|
+
<pre><code>{{signatures[0].comment.tags | inspect}}</code></pre>
|
599
|
+
</details>
|
600
|
+
{% endif %}
|