README.md

@esri/arcgis-rest-js

compact, modular JavaScript wrappers for the ArcGIS REST API that run in Node.js and modern browsers.

Table of Contents

• Example
• API Reference
• Instructions
• Packages
• FAQ
• Issues
• Versioning
• Contributing
• Code of Conduct
• License

Example

import { request } from '@esri/arcgis-rest-request';

const url = "https://www.arcgis.com/sharing/rest/content/items/6e03e8c26aad4b9c92a87c1063ddb0e3/data";

request(url)
    .then(response => {
        console.log(response) // WebMap JSON
    })

API Reference

The documentation is published at http://esri.github.io/arcgis-rest-js/ (source code here).

Instructions

You can install dependencies (and bootstrap lerna) by cloning the repository and running:

npm install

Afterward, for a list of all available commands run npm run.

Some useful commands include:

• npm test runs all the tests and confirms the API is functioning as expected.
• There is also a Debug Node Tests configuration in the .vscode/launch.json which will run the Node tests in the VS Code debugger.
• npm run docs:serve will run the documentation site locally at http://localhost:3000
• npm run build will created UMD bundles for all the packages

Packages

• @esri/arcgis-rest-request - Underpins other packages and supports making low-level requests.
• @esri/arcgis-rest-auth - Provides methods for authenticating named users and applications.
• @esri/arcgis-rest-common-types - Stores objects common across the ArcGIS API.
• @esri/arcgis-rest-items - Methods for working with ArcGIS Online/Enterprise content.
• @esri/arcgis-rest-groups - Methods for working with ArcGIS Online/Enterprise groups.
• @esri/arcgis-rest-users - Methods for working with ArcGIS Online/Enterprise users.
• @esri/arcgis-rest-sharing - Methods for updating permissions for ArcGIS Online/Enterprise content.
• @esri/arcgis-rest-feature-service - Functions for working with feature services
• @esri/arcgis-rest-geocoder - Geocoding wrapper for @esri/arcgis-rest-js

Frequently Asked Questions

• Is this a supported Esri product?
• How does this project compare with the ArcGIS API for JavaScript?
• Is this similar to the ArcGIS API for Python?
• Why TypeScript? What if I prefer VanillaJS?

Issues

If something isn't working the way you expected, please take a look at previously logged issues first. Have you found a new bug? Want to request a new feature? We'd love to hear from you.

If you're looking for help you can also post issues on GIS Stackexchange.

Versioning

For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.

For more information on SemVer, please visit http://semver.org/.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

License

Copyright © 2018 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's LICENSE file.