@esri/arcgis-rest-feature-service - npm Package Compare versions

Comparing version 1.2.1 to 1.3.0

dist/esm/features.d.ts

@@ -95,3 +95,3 @@ import { esriGeometryType, SpatialRelationship, IFeature, IGeometry, ISpatialReference, IFeatureSet } from "@esri/arcgis-rest-common-types";
 /**
- * add, update and delete features results
+ * Add, update and delete features result Object.
  */
@@ -104,29 +104,52 @@ export interface IEditFeatureResult {
 /**
- * add and update features update parameters
+ * Common add and update features parameters.
  */
 export interface IEditFeaturesParams extends IParams {
+    /**
+     * The geodatabase version to apply the edits.
+     */
     gdbVersion?: string;
+    /**
+     * Optional parameter specifying whether the response will report the time features were added.
+     */
     returnEditMoment?: boolean;
+    /**
+     * Optional parameter to specify if the edits should be applied only if all submitted edits succeed.
+     */
     rollbackOnFailure?: boolean;
 }
 /**
- * add features request options
+ * Add features request options.
  *
- * @param url - layer service url
- * @param params - query parameters to be sent to the feature service
+ * @param url - Feature service url.
+ * @param adds - Array of JSON features to add.
+ * @param params - Query parameters to be sent to the feature service via the request.
  */
 export interface IAddFeaturesRequestOptions extends IRequestOptions {
+    /**
+     * Feature service url.
+     */
     url: string;
+    /**
+     * Array of JSON features to add.
+     */
     adds: IFeature[];
+    /**
+     * Query parameters to be sent to the feature service via the request.
+     */
     params?: IEditFeaturesParams;
 }
 /**
- * add features results
+ * Add features results.
  */
 export interface IAddFeaturesResult {
+    /**
+     * Array of JSON response Object(s) for each feature added.
+     */
     addResults?: IEditFeatureResult[];
 }
 /**
- * Add features
+ * Add features request.
  *
+ * @param requestOptions - Options for the request.
  * ```js
@@ -146,3 +169,3 @@ * import { addFeatures } from '@esri/arcgis-rest-feature-service';
  *
- * @param requestOptions - Options for the request
+ * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the addFeatures response.
@@ -152,20 +175,33 @@ */
 /**
- * update features request options
+ * Update features request options.
  *
- * @param url - layer service url
- * @param params - query parameters to be sent to the feature service
+ * @param url - Feature service url.
+ * @param updates - Array of JSON features to update.
+ * @param params - Query parameters to be sent to the feature service via the request.
  */
 export interface IUpdateFeaturesRequestOptions extends IRequestOptions {
+    /**
+     * Feature service url.
+     */
     url: string;
+    /**
+     * Array of JSON features to update.
+     */
     updates: IFeature[];
+    /**
+     * Query parameters to be sent to the feature service via the request.
+     */
     params?: IEditFeaturesParams;
 }
 /**
- * update features results
+ * Update features results.
  */
 export interface IUpdateFeaturesResult {
+    /**
+     * Array of JSON response Object(s) for each feature updated.
+     */
     updateResults?: IEditFeatureResult[];
 }
 /**
- * Update features
+ * Update features request.
  *
@@ -186,3 +222,3 @@ * ```js
  *
- * @param requestOptions - Options for the request
+ * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the updateFeatures response.
@@ -192,3 +228,3 @@ */
 /**
- * delete features parameters
+ * Delete features parameters.
  */
@@ -198,20 +234,33 @@ export interface IDeleteFeaturesParams extends IEditFeaturesParams, ISharedQueryParams {
 /**
- * delete features request options
+ * Delete features request options.
  *
- * @param url - layer service url
- * @param params - query parameters to be sent to the feature service
+ * @param url - Feature service url.
+ * @param deletes - Array of objectIds to delete.
+ * @param params - Query parameters to be sent to the feature service via the request.
  */
 export interface IDeleteFeaturesRequestOptions extends IRequestOptions {
+    /**
+     * Feature service url.
+     */
     url: string;
+    /**
+     * Array of objectIds to delete.
+     */
     deletes: number[];
+    /**
+     * Query parameters to be sent to the feature service via the request.
+     */
     params?: IDeleteFeaturesParams;
 }
 /**
- * update features results
+ * Delete features results.
  */
 export interface IDeleteFeaturesResult {
+    /**
+     * Array of JSON response Object(s) for each feature deleted.
+     */
     deleteResults?: IEditFeatureResult[];
 }
 /**
- * Delete features
+ * Delete features request.
  *
@@ -229,5 +278,5 @@ * ```js
  *
- * @param deleteFeaturesRequestOptions - Options for the request
+ * @param deleteFeaturesRequestOptions - Options for the request.
  * @returns A Promise that will resolve with the deleteFeatures response.
  */
 export declare function deleteFeatures(requestOptions: IDeleteFeaturesRequestOptions): Promise<IDeleteFeaturesResult>;

dist/esm/features.js

@@ -37,4 +37,5 @@ import * as tslib_1 from "tslib";
 /**
- * Add features
+ * Add features request.
  *
+ * @param requestOptions - Options for the request.
  * ```js
@@ -54,3 +55,3 @@ * import { addFeatures } from '@esri/arcgis-rest-feature-service';
  *
- * @param requestOptions - Options for the request
+ * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the addFeatures response.
@@ -67,3 +68,3 @@ */
 /**
- * Update features
+ * Update features request.
  *
@@ -84,3 +85,3 @@ * ```js
  *
- * @param requestOptions - Options for the request
+ * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the updateFeatures response.
@@ -97,3 +98,3 @@ */
 /**
- * Delete features
+ * Delete features request.
  *
@@ -111,3 +112,3 @@ * ```js
  *
- * @param deleteFeaturesRequestOptions - Options for the request
+ * @param deleteFeaturesRequestOptions - Options for the request.
  * @returns A Promise that will resolve with the deleteFeatures response.
@@ -114,0 +115,0 @@ */

dist/node/features.js

@@ -41,4 +41,5 @@ "use strict";
 /**
- * Add features
+ * Add features request.
  *
+ * @param requestOptions - Options for the request.
  * ```js
@@ -58,3 +59,3 @@ * import { addFeatures } from '@esri/arcgis-rest-feature-service';
  *
- * @param requestOptions - Options for the request
+ * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the addFeatures response.
@@ -72,3 +73,3 @@ */
 /**
- * Update features
+ * Update features request.
  *
@@ -89,3 +90,3 @@ * ```js
  *
- * @param requestOptions - Options for the request
+ * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the updateFeatures response.
@@ -103,3 +104,3 @@ */
 /**
- * Delete features
+ * Delete features request.
  *
@@ -117,3 +118,3 @@ * ```js
  *
- * @param deleteFeaturesRequestOptions - Options for the request
+ * @param deleteFeaturesRequestOptions - Options for the request.
  * @returns A Promise that will resolve with the deleteFeatures response.
@@ -120,0 +121,0 @@ */

dist/umd/feature-service.umd.js

 /* @preserve
-* @esri/arcgis-rest-feature-service - v1.2.1 - Tue May 15 2018 16:54:59 GMT-0700 (PDT)
+* @esri/arcgis-rest-feature-service - v1.3.0 - Wed May 23 2018 11:30:39 GMT-0700 (PDT)
 * Copyright (c) 2017 - 2018 Environmental Systems Research Institute, Inc.
@@ -72,4 +72,5 @@ * Apache-2.0
 /**
- * Add features
+ * Add features request.
  *
+ * @param requestOptions - Options for the request.
  * ```js
@@ -89,3 +90,3 @@ * import { addFeatures } from '@esri/arcgis-rest-feature-service';
  *
- * @param requestOptions - Options for the request
+ * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the addFeatures response.
@@ -102,3 +103,3 @@ */
 /**
- * Update features
+ * Update features request.
  *
@@ -119,3 +120,3 @@ * ```js
  *
- * @param requestOptions - Options for the request
+ * @param requestOptions - Options for the request.
  * @returns A Promise that will resolve with the updateFeatures response.
@@ -132,3 +133,3 @@ */
 /**
- * Delete features
+ * Delete features request.
  *
@@ -146,3 +147,3 @@ * ```js
  *
- * @param deleteFeaturesRequestOptions - Options for the request
+ * @param deleteFeaturesRequestOptions - Options for the request.
  * @returns A Promise that will resolve with the deleteFeatures response.
@@ -149,0 +150,0 @@ */

dist/umd/feature-service.umd.min.js

 /* @preserve
-* @esri/arcgis-rest-feature-service - v1.2.1 - Tue May 15 2018 16:55:03 GMT-0700 (PDT)
+* @esri/arcgis-rest-feature-service - v1.3.0 - Wed May 23 2018 11:30:41 GMT-0700 (PDT)
 * Copyright (c) 2017 - 2018 Environmental Systems Research Institute, Inc.
@@ -4,0 +4,0 @@ * Apache-2.0

package.json

 {
   "name": "@esri/arcgis-rest-feature-service",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Feature service helpers for @esri/arcgis-rest-request",
@@ -22,4 +22,4 @@ "main": "dist/node/index.js",
   "devDependencies": {
-    "@esri/arcgis-rest-common-types": "^1.2.1",
-    "@esri/arcgis-rest-request": "^1.2.1"
+    "@esri/arcgis-rest-common-types": "^1.3.0",
+    "@esri/arcgis-rest-request": "^1.3.0"
   },
@@ -26,0 +26,0 @@ "scripts": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

70198

increased by6.76%

Lines of code

686

increased by8.2%

Worsened metrics

Number of medium supply chain risk alerts

3

increased by50%

No dependency changes