@esri/arcgis-rest-demographics
Advanced tools
Comparing version 4.0.0-beta.3 to 4.0.0
/* @preserve | ||
* @esri/arcgis-rest-demographics - v4.0.0-beta.2 - Apache-2.0 | ||
* @esri/arcgis-rest-demographics - v4.0.0-beta.5 - Apache-2.0 | ||
* Copyright (c) 2017-2022 Esri, Inc. | ||
* Thu Mar 10 2022 23:21:03 GMT+0000 (Coordinated Universal Time) | ||
* Mon Apr 18 2022 16:42:05 GMT+0000 (Coordinated Universal Time) | ||
*/ | ||
@@ -17,5 +17,7 @@ import { appendCustomParams, request, cleanUrl } from '@esri/arcgis-rest-request'; | ||
/** | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableCountries } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableCountries() | ||
@@ -26,3 +28,3 @@ * .then((response) => { | ||
* ``` | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -54,5 +56,7 @@ * @returns A Promise that will resolve with available geography levels for the request. | ||
/** | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableDataCollections() | ||
@@ -62,3 +66,3 @@ * .then((response) => { | ||
* }); | ||
* // | ||
* | ||
* getAvailableDataCollections({ | ||
@@ -72,3 +76,3 @@ * countryCode: "se", | ||
* ``` | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -107,2 +111,4 @@ * @returns A Promise that will resolve with data collections for the request. | ||
/** | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* ```js | ||
@@ -116,3 +122,3 @@ * import { getAvailableGeographyLevels } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -143,2 +149,4 @@ * @returns A Promise that will resolve with available geography levels for the request. | ||
/** | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* ```js | ||
@@ -155,3 +163,3 @@ * import { getGeography } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. All properties are optional, but either `geographyIds` or `geographyQuery` must be sent at a minimum. | ||
@@ -199,2 +207,4 @@ * @returns A Promise that will resolve with return data defined and optionally geometry for the feature. | ||
/** | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* ```js | ||
@@ -211,3 +221,3 @@ * import { queryDemographicData } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. | ||
@@ -214,0 +224,0 @@ * @returns A Promise that will resolve with results for the request. |
/* @preserve | ||
* @esri/arcgis-rest-demographics - v4.0.0-beta.2 - Apache-2.0 | ||
* @esri/arcgis-rest-demographics - v4.0.0-beta.5 - Apache-2.0 | ||
* Copyright (c) 2017-2022 Esri, Inc. | ||
* Thu Mar 10 2022 23:21:03 GMT+0000 (Coordinated Universal Time) | ||
* Mon Apr 18 2022 16:42:05 GMT+0000 (Coordinated Universal Time) | ||
*/ | ||
import{appendCustomParams as e,request as r,cleanUrl as a}from"@esri/arcgis-rest-request";const t="https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment";function s(s){let n={},i=`${t}/countries`;return s?(s.endpoint&&(i=`${s.endpoint}/countries`),n=e(s,[],{params:Object.assign({},s.params)}),s.countryCode&&(i=`${i}/${s.countryCode}`)):n.params={},r(a(i),n).then((e=>e))}function n(s){let n={},i=`${t}/dataCollections`;return s?(s.endpoint&&(i=`${s.endpoint}/dataCollections`),n=e(s,["addDerivativeVariables","suppressNullValues"],{params:Object.assign({},s.params)}),n.params.addDerivativeVariables&&(n.params.addDerivativeVariables=JSON.stringify(n.params.addDerivativeVariables)),s.countryCode&&(i=`${i}/${s.countryCode}`,s.dataCollection&&(i=`${i}/${s.dataCollection}`))):n.params={},r(`${a(i)}`,n).then((e=>e))}function i(s){let n={},i=`${t}/StandardGeographyLevels`;return s?(s.endpoint&&(i=`${s.endpoint}/StandardGeographyLevels`),n=e(s,[],{params:Object.assign({},s.params)})):n.params={},r(`${a(i)}`,n).then((e=>e))}function o(t){const s=`${t.endpoint||"https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/StandardGeographyQuery"}/execute`,n=e(t,["sourceCountry","optionalCountryDataset","geographyLayers","geographyIDs","geographyQuery","returnSubGeographyLayer","subGeographyLayer","subGeographyQuery","outSR","returnGeometry","returnCentroids","generalizationLevel","useFuzzySearch","featureLimit","featureOffset","langCode"],{params:Object.assign({},t.params)});return t.authentication?(["geographyLayers","geographyIDs"].forEach((e=>{n.params[e]&&(n.params[e]=JSON.stringify(n.params[e]))})),r(`${a(s)}`,n).then((e=>e))):Promise.reject("Geoenrichment using the ArcGIS service requires authentication")}function c(s){const n=e(s,["studyAreas","dataCollections","analysisVariables","addDerivativeVariables","returnGeometry","inSR","outSR"],{params:Object.assign({},s.params)});return s.authentication?(["dataCollections","analysisVariables"].forEach((e=>{n.params[e]&&(n.params[e]=JSON.stringify(n.params[e]))})),r(`${a(`${s.endpoint||t}/enrich`)}`,n).then((e=>e))):Promise.reject("Geoenrichment using the ArcGIS service requires authentication")}export{s as getAvailableCountries,n as getAvailableDataCollections,i as getAvailableGeographyLevels,o as getGeography,c as queryDemographicData}; | ||
//# sourceMappingURL=demographics.esm.min.js.map |
/* @preserve | ||
* @esri/arcgis-rest-demographics - v4.0.0-beta.2 - Apache-2.0 | ||
* @esri/arcgis-rest-demographics - v4.0.0-beta.5 - Apache-2.0 | ||
* Copyright (c) 2017-2022 Esri, Inc. | ||
* Thu Mar 10 2022 23:21:03 GMT+0000 (Coordinated Universal Time) | ||
* Mon Apr 18 2022 16:42:05 GMT+0000 (Coordinated Universal Time) | ||
*/ | ||
@@ -21,5 +21,7 @@ (function (global, factory) { | ||
/** | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableCountries } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableCountries() | ||
@@ -30,3 +32,3 @@ * .then((response) => { | ||
* ``` | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -58,5 +60,7 @@ * @returns A Promise that will resolve with available geography levels for the request. | ||
/** | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableDataCollections() | ||
@@ -66,3 +70,3 @@ * .then((response) => { | ||
* }); | ||
* // | ||
* | ||
* getAvailableDataCollections({ | ||
@@ -76,3 +80,3 @@ * countryCode: "se", | ||
* ``` | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -111,2 +115,4 @@ * @returns A Promise that will resolve with data collections for the request. | ||
/** | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* ```js | ||
@@ -120,3 +126,3 @@ * import { getAvailableGeographyLevels } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -147,2 +153,4 @@ * @returns A Promise that will resolve with available geography levels for the request. | ||
/** | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* ```js | ||
@@ -159,3 +167,3 @@ * import { getGeography } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. All properties are optional, but either `geographyIds` or `geographyQuery` must be sent at a minimum. | ||
@@ -203,2 +211,4 @@ * @returns A Promise that will resolve with return data defined and optionally geometry for the feature. | ||
/** | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* ```js | ||
@@ -215,3 +225,3 @@ * import { queryDemographicData } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. | ||
@@ -218,0 +228,0 @@ * @returns A Promise that will resolve with results for the request. |
/* @preserve | ||
* @esri/arcgis-rest-demographics - v4.0.0-beta.2 - Apache-2.0 | ||
* @esri/arcgis-rest-demographics - v4.0.0-beta.5 - Apache-2.0 | ||
* Copyright (c) 2017-2022 Esri, Inc. | ||
* Thu Mar 10 2022 23:21:03 GMT+0000 (Coordinated Universal Time) | ||
* Mon Apr 18 2022 16:42:05 GMT+0000 (Coordinated Universal Time) | ||
*/ | ||
!function(e,a){"object"==typeof exports&&"undefined"!=typeof module?a(exports,require("@esri/arcgis-rest-request")):"function"==typeof define&&define.amd?define(["exports","@esri/arcgis-rest-request"],a):a((e="undefined"!=typeof globalThis?globalThis:e||self).arcgisRest=e.arcgisRest||{},e.arcgisRest)}(this,(function(e,a){"use strict";const r="https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver",t=`${r}/Geoenrichment`,s=`${r}/StandardGeographyQuery`;e.getAvailableCountries=function(e){let r={},s=`${t}/countries`;return e?(e.endpoint&&(s=`${e.endpoint}/countries`),r=a.appendCustomParams(e,[],{params:Object.assign({},e.params)}),e.countryCode&&(s=`${s}/${e.countryCode}`)):r.params={},a.request(a.cleanUrl(s),r).then((e=>e))},e.getAvailableDataCollections=function(e){let r={},s=`${t}/dataCollections`;return e?(e.endpoint&&(s=`${e.endpoint}/dataCollections`),r=a.appendCustomParams(e,["addDerivativeVariables","suppressNullValues"],{params:Object.assign({},e.params)}),r.params.addDerivativeVariables&&(r.params.addDerivativeVariables=JSON.stringify(r.params.addDerivativeVariables)),e.countryCode&&(s=`${s}/${e.countryCode}`,e.dataCollection&&(s=`${s}/${e.dataCollection}`))):r.params={},a.request(`${a.cleanUrl(s)}`,r).then((e=>e))},e.getAvailableGeographyLevels=function(e){let r={},s=`${t}/StandardGeographyLevels`;return e?(e.endpoint&&(s=`${e.endpoint}/StandardGeographyLevels`),r=a.appendCustomParams(e,[],{params:Object.assign({},e.params)})):r.params={},a.request(`${a.cleanUrl(s)}`,r).then((e=>e))},e.getGeography=function(e){const r=`${e.endpoint||s}/execute`,t=a.appendCustomParams(e,["sourceCountry","optionalCountryDataset","geographyLayers","geographyIDs","geographyQuery","returnSubGeographyLayer","subGeographyLayer","subGeographyQuery","outSR","returnGeometry","returnCentroids","generalizationLevel","useFuzzySearch","featureLimit","featureOffset","langCode"],{params:Object.assign({},e.params)});return e.authentication?(["geographyLayers","geographyIDs"].forEach((e=>{t.params[e]&&(t.params[e]=JSON.stringify(t.params[e]))})),a.request(`${a.cleanUrl(r)}`,t).then((e=>e))):Promise.reject("Geoenrichment using the ArcGIS service requires authentication")},e.queryDemographicData=function(e){const r=a.appendCustomParams(e,["studyAreas","dataCollections","analysisVariables","addDerivativeVariables","returnGeometry","inSR","outSR"],{params:Object.assign({},e.params)});return e.authentication?(["dataCollections","analysisVariables"].forEach((e=>{r.params[e]&&(r.params[e]=JSON.stringify(r.params[e]))})),a.request(`${a.cleanUrl(`${e.endpoint||t}/enrich`)}`,r).then((e=>e))):Promise.reject("Geoenrichment using the ArcGIS service requires authentication")},Object.defineProperty(e,"__esModule",{value:!0})})); | ||
//# sourceMappingURL=demographics.umd.min.js.map |
@@ -9,5 +9,7 @@ "use strict"; | ||
/** | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableCountries } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableCountries() | ||
@@ -18,3 +20,3 @@ * .then((response) => { | ||
* ``` | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -21,0 +23,0 @@ * @returns A Promise that will resolve with available geography levels for the request. |
@@ -9,5 +9,7 @@ "use strict"; | ||
/** | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableDataCollections() | ||
@@ -17,3 +19,3 @@ * .then((response) => { | ||
* }); | ||
* // | ||
* | ||
* getAvailableDataCollections({ | ||
@@ -27,3 +29,3 @@ * countryCode: "se", | ||
* ``` | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -30,0 +32,0 @@ * @returns A Promise that will resolve with data collections for the request. |
@@ -9,2 +9,4 @@ "use strict"; | ||
/** | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* ```js | ||
@@ -18,3 +20,3 @@ * import { getAvailableGeographyLevels } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -21,0 +23,0 @@ * @returns A Promise that will resolve with available geography levels for the request. |
@@ -9,2 +9,4 @@ "use strict"; | ||
/** | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* ```js | ||
@@ -21,3 +23,3 @@ * import { getGeography } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. All properties are optional, but either `geographyIds` or `geographyQuery` must be sent at a minimum. | ||
@@ -24,0 +26,0 @@ * @returns A Promise that will resolve with return data defined and optionally geometry for the feature. |
@@ -9,2 +9,4 @@ "use strict"; | ||
/** | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* ```js | ||
@@ -21,3 +23,3 @@ * import { queryDemographicData } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. | ||
@@ -24,0 +26,0 @@ * @returns A Promise that will resolve with results for the request. |
@@ -60,5 +60,7 @@ import { IExtent } from "@esri/arcgis-rest-request"; | ||
/** | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableCountries } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableCountries() | ||
@@ -69,3 +71,3 @@ * .then((response) => { | ||
* ``` | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -72,0 +74,0 @@ * @returns A Promise that will resolve with available geography levels for the request. |
@@ -6,5 +6,7 @@ /* Copyright (c) 2020 Environmental Systems Research Institute, Inc. | ||
/** | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableCountries } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableCountries() | ||
@@ -15,3 +17,3 @@ * .then((response) => { | ||
* ``` | ||
* Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -18,0 +20,0 @@ * @returns A Promise that will resolve with available geography levels for the request. |
@@ -90,5 +90,7 @@ import { IEndpointOptions } from "./helpers.js"; | ||
/** | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableDataCollections() | ||
@@ -98,3 +100,3 @@ * .then((response) => { | ||
* }); | ||
* // | ||
* | ||
* getAvailableDataCollections({ | ||
@@ -108,3 +110,3 @@ * countryCode: "se", | ||
* ``` | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -111,0 +113,0 @@ * @returns A Promise that will resolve with data collections for the request. |
@@ -6,5 +6,7 @@ /* Copyright (c) 2020 Environmental Systems Research Institute, Inc. | ||
/** | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* ```js | ||
* import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics'; | ||
* // | ||
* | ||
* getAvailableDataCollections() | ||
@@ -14,3 +16,3 @@ * .then((response) => { | ||
* }); | ||
* // | ||
* | ||
* getAvailableDataCollections({ | ||
@@ -24,3 +26,3 @@ * countryCode: "se", | ||
* ``` | ||
* Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -27,0 +29,0 @@ * @returns A Promise that will resolve with data collections for the request. |
@@ -40,2 +40,4 @@ import { IEndpointOptions } from "./helpers.js"; | ||
/** | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* ```js | ||
@@ -49,3 +51,3 @@ * import { getAvailableGeographyLevels } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -52,0 +54,0 @@ * @returns A Promise that will resolve with available geography levels for the request. |
@@ -6,2 +6,4 @@ /* Copyright (c) 2020 Environmental Systems Research Institute, Inc. | ||
/** | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* ```js | ||
@@ -15,3 +17,3 @@ * import { getAvailableGeographyLevels } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the geoenrichment service. | ||
@@ -18,0 +20,0 @@ * @returns A Promise that will resolve with available geography levels for the request. |
@@ -73,2 +73,4 @@ import { IGeoenrichmentResult, IEndpointOptions } from "./helpers.js"; | ||
/** | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* ```js | ||
@@ -85,3 +87,3 @@ * import { getGeography } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. All properties are optional, but either `geographyIds` or `geographyQuery` must be sent at a minimum. | ||
@@ -88,0 +90,0 @@ * @returns A Promise that will resolve with return data defined and optionally geometry for the feature. |
@@ -6,2 +6,4 @@ /* Copyright (c) 2020 Environmental Systems Research Institute, Inc. | ||
/** | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* ```js | ||
@@ -18,3 +20,3 @@ * import { getGeography } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. All properties are optional, but either `geographyIds` or `geographyQuery` must be sent at a minimum. | ||
@@ -21,0 +23,0 @@ * @returns A Promise that will resolve with return data defined and optionally geometry for the feature. |
@@ -37,2 +37,4 @@ import { IGeoenrichmentResult, IEndpointOptions } from "./helpers.js"; | ||
/** | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* ```js | ||
@@ -49,3 +51,3 @@ * import { queryDemographicData } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. | ||
@@ -52,0 +54,0 @@ * @returns A Promise that will resolve with results for the request. |
@@ -6,2 +6,4 @@ /* Copyright (c) 2020 Environmental Systems Research Institute, Inc. | ||
/** | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* ```js | ||
@@ -18,3 +20,3 @@ * import { queryDemographicData } from '@esri/arcgis-rest-demographics'; | ||
* ``` | ||
* Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information. | ||
* | ||
* @param requestOptions Options to pass through to the service. | ||
@@ -21,0 +23,0 @@ * @returns A Promise that will resolve with results for the request. |
{ | ||
"name": "@esri/arcgis-rest-demographics", | ||
"version": "4.0.0-beta.3", | ||
"version": "4.0.0", | ||
"description": "Demographics data helpers for @esri/arcgis-rest-js", | ||
@@ -50,6 +50,6 @@ "license": "Apache-2.0", | ||
"peerDependencies": { | ||
"@esri/arcgis-rest-request": "4.0.0-beta.3" | ||
"@esri/arcgis-rest-request": "4.0.0" | ||
}, | ||
"devDependencies": { | ||
"@esri/arcgis-rest-request": "4.0.0-beta.3" | ||
"@esri/arcgis-rest-request": "4.0.0" | ||
}, | ||
@@ -71,3 +71,8 @@ "contributors": [ | ||
"access": "public" | ||
}, | ||
"esri": { | ||
"keyExports": [ | ||
"queryDemographicData" | ||
] | ||
} | ||
} |
@@ -60,3 +60,3 @@ [![npm version][npm-img]][npm-url] | ||
Copyright © 2017-2019 Esri | ||
Copyright © 2017-2022 Esri | ||
@@ -63,0 +63,0 @@ Licensed under the Apache License, Version 2.0 (the "License"); |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
211818
1439
1