node-arcgis (Deprecated)

This libray has been retired. Please consider migrating to arcgis-rest-js.

Node/Browser Javascript library for ArcGIS

Usage

npm install arcgis

var ArcGIS = require('arcgis')
var ago = ArcGIS({token: 'usertoken'})

Documentation

API Reference and Examples https://esri.github.io/node-arcgis

Contributing

This is an OPEN Open Source Project. Anyone and everyone is welcome to contribute. Please see our guidelines for contributing for more information.

Licensing

Copyright 2016 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.txt file.

Project Goals

This project should be more than just a wrapper around our current REST API, but an aspirational and forward looking attempt to create what the REST API could be. Some of the primary targets are below:

Simple Simple Simple

The end goal is for everything to be as simple as possible. Simple code, simple structures, simple responses, simple docs. If things get complicated we're doing something wrong.

Modular

Every method and function should be it's own self sufficient deal - both for ease of comprehension (one file does one thing) but also for consumption. Ideally, each module could be required independently and work great. This means we're using ES6!

Promises

Practically all of these methods require making calls to ArcGIS servers. Since we can't control the time required to receive a response, most everything is Async and returns a promise.

Value Added

This project should work to simplify and unify the conceptual model for the ease of the programmer. This library is a UI in the most basic sense of the term — we're providing an interface between the developer and the API, and that interface needs to be well designed and thought through to make the process and smooth, intuitive, and pleasurable as possible.

For example, getting an org's name, description, and summary is 2 calls to the REST API. In this library, that should be one call.

Universal Iso-PolyMetric Server Client JS

This should run in node land on the server and in the browser as well. The same code should work the same way in both places. This will expand out to cover instances of on-premise server as well as ArcGIS Online.

Revolutionary Framework: Vanilla JS

This is framework agnostic. No dependencies, should work anywhere and everywhere. No dojo, no angular, no jquery, no lodash, no nothin'.