@esri/arcgis-rest-request
Version:
Common methods and utilities for @esri/arcgis-rest-js packages.
55 lines (54 loc) • 1.84 kB
JavaScript
;
/* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
* Apache-2.0 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.ApiKey = exports.ApiKeyManager = void 0;
const AuthenticationManagerBase_js_1 = require("./AuthenticationManagerBase.js");
/**
* Used to authenticate methods in ArcGIS REST JS with an API keys. The instance of `ApiKeyManager` can be passed to {@linkcode IRequestOptions.authentication} to authenticate requests.
*
* ```js
* import { ApiKeyManager } from '@esri/arcgis-rest-request';
* const apiKey = new ApiKeyManager.fromKey("...");
* ```
*
* In most cases however the API key can be passed directly to the {@linkcode IRequestOptions.authentication}.
*/
class ApiKeyManager extends AuthenticationManagerBase_js_1.AuthenticationManagerBase {
constructor(options) {
super(options);
/**
* The current portal the user is authenticated with.
*/
this.portal = "https://www.arcgis.com/sharing/rest";
this.key = options.key;
}
/**
* The preferred method for creating an instance of `ApiKeyManager`.
*/
static fromKey(apiKey) {
if (typeof apiKey === "string") {
return new ApiKeyManager({ key: apiKey });
}
else {
return new ApiKeyManager(apiKey);
}
}
/**
* Gets a token (the API Key).
*/
getToken(url) {
return Promise.resolve(this.key);
}
}
exports.ApiKeyManager = ApiKeyManager;
/**
* @deprecated - Use {@linkcode ApiKeyManager}.
* @internal
*/ /* istanbul ignore next */
function ApiKey(options) {
console.log("DEPRECATED:, 'ApiKey' is deprecated. Use 'ApiKeyManager' instead.");
return new ApiKeyManager(options);
}
exports.ApiKey = ApiKey;
//# sourceMappingURL=ApiKeyManager.js.map