Giter Club home page Giter Club logo

arcgis-rest-js's Introduction

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 Stack Overflow with the esri-oss tag.

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.

arcgis-rest-js's People

Contributors

alukach avatar cov-gis avatar dbouwman avatar deeg avatar dependabot[bot] avatar dkaminari avatar drewdaemon avatar ez4gis avatar gavinr avatar gavinr-maps avatar haoliangyu avatar hogpilot avatar itrew avatar jeffjacobson avatar jf990 avatar jgravois avatar maneetgoyal avatar miketschudi avatar mjuniper avatar mpayson avatar noahmulfinger avatar oselz avatar patrickarlt avatar pfcstyle avatar pranavkulkarni avatar rgwozdz avatar sandromartis avatar ssylvia avatar subgan82 avatar tomwayson avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.