compact, modular JavaScript wrappers for the ArcGIS REST API
Branch: master
Clone or download
jgravois Merge pull request #464 from Esri/chore/cleanup
cleanup redirect page and provide a real clientid in basic OAuth 2.0 browser demo
Latest commit d3a2142 Feb 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode fix(request): ensure falsy request parameters are passed through Mar 3, 2018
demos Merge pull request #464 from Esri/chore/cleanup Feb 16, 2019
docs 💅 Feb 14, 2019
notes fixed spelling Oct 23, 2018
packages feat(request): adds option to return the raw fetch response Feb 15, 2019
support change sequence of operations for generating sri hashes Jan 16, 2019
.gitignore fix(🔍): allow node.js clients to access streams Oct 29, 2018
.prettierignore chore(prettier): ignore package.json and package-lock.json Dec 22, 2017
.travis.yml switch from coveralls to codecov to report on coverage Jan 17, 2019
CHANGELOG.md v1.16.1 Jan 30, 2019
CODE_OF_CONDUCT.md add license, update urls (#57) Sep 29, 2017
CONTRIBUTING.md chore(👀): watch raw source for changes and recompile Oct 15, 2018
LICENSE add license, update urls (#57) Sep 29, 2017
README.md feat(request): adds option to return the raw fetch response Feb 15, 2019
codecov.yml switch from coveralls to codecov to report on coverage Jan 17, 2019
jasmine.json feat(request): allow passing custom fetch function Sep 13, 2017
karma.conf.js fix(🐛): ensure createFeatureService doesnt swallow errors Jan 29, 2019
lerna.json v1.16.1 Jan 30, 2019
package-lock.json feat(request): adds option to return the raw fetch response Feb 15, 2019
package.json v1.16.1 Jan 30, 2019
tsconfig.json baseline item CRUD methods Nov 6, 2017
tslint.json feat: by default fetch metadata and make query response readable Nov 12, 2018
umd-base-profile.js less is more Jul 31, 2018
umd-production-profile.js chore(umd): make umd filenames more terse May 14, 2018

README.md

npm version build status gzip bundle size Coverage Status apache 2.0 licensed

@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

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/arcgis-rest-js/
  • npm run build will created UMD bundles for all the packages
  • npm run dev -- <esm|node|umd> <glob> will re-run the specified build type anytime the source code changes. Example: npm run dev -- umd @esri/*

Packages

Frequently Asked Questions

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 © 2017-2019 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.