@esri/solution-common 1.3.10 → 1.3.13

package/dist/umd/generalHelpers.d.ts

@@ -20,14 +20,14 @@ import { Sanitizer } from "./libConnectors";
  *
  * @param url URL to append to
  * @param parameter Query parameter to append, prefixed with "?" or "&" as appropriate to what url already has
- * @return New URL combining url and parameter
+ * @returns New URL combining url and parameter
  */
 export declare function appendQueryParam(url: string, parameter: string): string;
 /**
  * Extracts JSON from a Blob.
  *
  * @param blob Blob to use as source
- * @return A promise that will resolve with JSON or null
+ * @returns A promise that will resolve with JSON or null
  */
 export declare function blobToJson(blob: Blob): Promise<any>;
 /**
@@ -36,34 +36,34 @@ export declare function blobToJson(blob: Blob): Promise<any>;
  * @param blob Blob to use as source
  * @param filename Name to use for file
  * @param mimeType MIME type to override blob's MIME type
- * @return File created out of Blob and filename
+ * @returns File created out of Blob and filename
  */
 export declare function blobToFile(blob: Blob, filename: string, mimeType?: string): File;
 /**
  * Extracts text from a Blob.
  *
  * @param blob Blob to use as source
- * @return A promise that will resolve with text read from blob
+ * @returns A promise that will resolve with text read from blob
  */
 export declare function blobToText(blob: Blob): Promise<string>;
 /**
  * Checks that a URL path ends with a slash.
  *
  * @param url URL to check
- * @return URL, appended with slash if missing
+ * @returns URL, appended with slash if missing
  */
 export declare function checkUrlPathTermination(url: string): string;
 /**
  * Creates a random 32-character alphanumeric string.
  *
- * @return A lowercase 32-char alphanumeric string
+ * @returns A lowercase 32-char alphanumeric string
  * @internal
  */
 export declare function createLongId(): string;
 /**
  * Creates a random 8-character alphanumeric string that begins with an alphabetic character.
  *
- * @return An alphanumeric string in the range [a0000000..zzzzzzzz]
+ * @returns An alphanumeric string in the range [a0000000..zzzzzzzz]
  */
 export declare function createShortId(): string;
 /**
@@ -78,14 +78,14 @@ export declare function dedupe(input?: string[]): string[];
  *
  * @param itemType The AGO item type
  * @param id Item id to include in response
- * @return Empty creation response
+ * @returns Empty creation response
  */
 export declare function generateEmptyCreationResponse(itemType: string, id?: string): ICreateItemFromTemplateResponse;
 /**
  * Converts JSON to a Blob.
  *
  * @param json JSON to use as source
- * @return A blob from the source JSON
+ * @returns A blob from the source JSON
  */
 export declare function jsonToBlob(json: any): Blob;
 /**
@@ -94,7 +94,7 @@ export declare function jsonToBlob(json: any): Blob;
  * @param json JSON to use as source
  * @param filename Name to use for file
  * @param mimeType MIME type to override blob's MIME type
- * @return File created out of JSON and filename
+ * @returns File created out of JSON and filename
  */
 export declare function jsonToFile(json: any, filename: string, mimeType?: string): File;
 /**
@@ -102,14 +102,14 @@ export declare function jsonToFile(json: any, filename: string, mimeType?: strin
  *
  * @param filename Name to give file
  * @param blob Blob to save
- * @return Promise resolving when operation is complete
+ * @returns Promise resolving when operation is complete
  */
 export declare function saveBlobAsFile(filename: string, blob: Blob): Promise<void>;
 /**
  * Makes a deep clone, including arrays but not functions.
  *
  * @param obj Object to be cloned
- * @return Clone of obj
+ * @returns Clone of obj
  * @example
  * ```js
  * import { cloneObject } from "utils/object-helpers";
@@ -127,7 +127,7 @@ export declare function cloneObject(obj: {
  *
  * @param json1 First object
  * @param json2 Second object
- * @return True if objects are the same
+ * @returns True if objects are the same
  */
 export declare function compareJSON(json1: any, json2: any): boolean;
 /**
@@ -135,7 +135,7 @@ export declare function compareJSON(json1: any, json2: any): boolean;
  *
  * @param json1 First object
  * @param json2 Second object
- * @return True if objects are the same
+ * @returns True if objects are the same
  */
 export declare function compareJSONNoEmptyStrings(json1: any, json2: any): boolean;
 /**
@@ -143,7 +143,7 @@ export declare function compareJSONNoEmptyStrings(json1: any, json2: any): boole
  *
  * @param json1 First object
  * @param json2 Second object
- * @return A list of mismatch report strings
+ * @returns A list of mismatch report strings
  */
 export declare function compareJSONProperties(json1: any, json2: any): string[];
 /**
@@ -151,7 +151,7 @@ export declare function compareJSONProperties(json1: any, json2: any): string[];
  *
  * @param json JSON to sanitize
  * @param sanitizer Instance of Sanitizer class
- * @return Sanitized version of `json`
+ * @returns Sanitized version of `json`
  * @see https://github.com/esri/arcgis-html-sanitizer#sanitize-json
  */
 export declare function sanitizeJSONAndReportChanges(json: any, sanitizer?: Sanitizer): any;
@@ -175,7 +175,7 @@ export declare function deleteProps(obj: any, props: string[]): void;
  * Creates an AGO-style JSON failure response with success property.
  *
  * @param e Optional error information
- * @return JSON structure with property success set to false and optionally including `e`
+ * @returns JSON structure with property success set to false and optionally including `e`
  */
 export declare function fail(e?: any): any;
 /**
@@ -183,14 +183,14 @@ export declare function fail(e?: any): any;
  *
  * @param ids List of ids
  * @param e Optional error information
- * @return JSON structure with property success set to false and optionally including `e`
+ * @returns JSON structure with property success set to false and optionally including `e`
  */
 export declare function failWithIds(itemIds: string[], e?: any): any;
 /**
  * Extracts the ids from a string
  *
  * @param v String to examine
- * @return List of id strings found
+ * @returns List of id strings found
  * @example
  * get id from
  *   bad3483e025c47338d43df308c117308
@@ -209,7 +209,7 @@ export declare function getIDs(v: string): string[];
  * @param obj Object to retrieve value from
  * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
  *             in obj
- * @return Value at end of path
+ * @returns Value at end of path
  */
 export declare function getProp(obj: {
     [index: string]: any;
@@ -219,7 +219,7 @@ export declare function getProp(obj: {
  *
  * @param obj Object to retrieve values from
  * @param props Array of paths into the object e.g., "data.values.webmap", where "data" is a top-level property
- * @return Array of the values plucked from the object; only defined values are returned
+ * @returns Array of the values plucked from the object; only defined values are returned
  */
 export declare function getProps(obj: any, props: string[]): any;
 /**
@@ -230,7 +230,7 @@ export declare function getProps(obj: any, props: string[]): any;
  * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
  *             in obj
  * @param defaultV Optional value to use if any part of path--including final value--is undefined
- * @return Value at end of path
+ * @returns Value at end of path
  */
 export declare function getPropWithDefault(obj: IStringValuePair, path: string, defaultV?: any): any;
 /**
@@ -262,9 +262,9 @@ export declare function setProp(obj: any, path: string, value: any): void;
 /**
  * Creates a timestamp string using the current UTC date and time.
  *
- * @return Timestamp formatted as YYYYMMDD_hhmm_ssmmm, with month one-based and all values padded with zeroes on the
+ * @returns Timestamp formatted as YYYYMMDD_hhmm_ssmmm, with month one-based and all values padded with zeroes on the
  * left as needed (`ssmmm` stands for seconds from 0..59 and milliseconds from 0..999)
- * @protected
+ * @private
  */
 export declare function getUTCTimestamp(): string;
 /**
@@ -272,7 +272,7 @@ export declare function getUTCTimestamp(): string;
  *
  * @param jsonObj Object to test
  * @param keywords List of keywords to look for in jsonObj
- * @return Boolean indicating result
+ * @returns Boolean indicating result
  */
 export declare function hasAnyKeyword(jsonObj: any, keywords: string[]): boolean;
 /**
@@ -280,7 +280,7 @@ export declare function hasAnyKeyword(jsonObj: any, keywords: string[]): boolean
  *
  * @param jsonObj Object to test
  * @param keyword Keyword to look for in jsonObj
- * @return Boolean indicating result
+ * @returns Boolean indicating result
  */
 export declare function hasTypeKeyword(jsonObj: any, keyword: string): boolean;
 /**
@@ -291,7 +291,7 @@ export declare function hasTypeKeyword(jsonObj: any, keyword: string): boolean;
  * @param title The root title to test
  * @param templateDictionary Hash of the facts
  * @param path to the objects to evaluate for potantial name clashes
- * @return string The unique title to use
+ * @returns string The unique title to use
  */
 export declare function getUniqueTitle(title: string, templateDictionary: any, path: string): string;
 /**
@@ -300,7 +300,7 @@ export declare function getUniqueTitle(title: string, templateDictionary: any, p
  * @param obj Object to scan and to modify
  * @param pattern Search pattern in each string
  * @param replacement Replacement for matches to search pattern
- * @return Modified obj is returned
+ * @returns Modified obj is returned
  */
 export declare function globalStringReplace(obj: any, pattern: RegExp, replacement: string): any;
 /**
@@ -309,7 +309,7 @@ export declare function globalStringReplace(obj: any, pattern: RegExp, replaceme
  * @param datasourceInfos Array of DatasourceInfos to evaluate
  * @param itemId The items id to check for
  * @param layerId The layers id to check for
- * @return Boolean indicating result
+ * @returns Boolean indicating result
  */
 export declare function hasDatasource(datasourceInfos: IDatasourceInfo[], itemId: string, layerId: number): boolean;
 /**
@@ -337,7 +337,7 @@ export declare function cleanLayerId(id: any): any;
  * @param templates Array of item templates to search
  * @param id of template we are searching for
  *
- * @return Template associated with the user provided id argument
+ * @returns Template associated with the user provided id argument
  */
 export declare function getTemplateById(templates: IItemTemplate[], id: string): any;
 /**
@@ -345,7 +345,7 @@ export declare function getTemplateById(templates: IItemTemplate[], id: string):
  *
  * @param v a string value to test with the expression
  * @param ex the regular expresion to test with
- * @return an array of matches
+ * @returns an array of matches
  */
 export declare function regExTest(v: any, ex: RegExp): any[];
 /**
@@ -353,7 +353,7 @@ export declare function regExTest(v: any, ex: RegExp): any[];
  *
  * @param min Inclusive minimum desired value
  * @param max Non-inclusive maximum desired value
- * @return Random number in the range [min, max)
+ * @returns Random number in the range [min, max)
  */
 export declare function _getRandomNumberInRange(min: number, max: number): number;
 /**
@@ -361,7 +361,7 @@ export declare function _getRandomNumberInRange(min: number, max: number): numbe
  *
  * @param n Number to pad
  * @param totalSize Desired *minimum* width of number after padding with zeroes
- * @return Number converted to string and padded on the left as needed
- * @protected
+ * @returns Number converted to string and padded on the left as needed
+ * @private
  */
 export declare function _padPositiveNum(n: number, totalSize: number): string;

package/dist/umd/getDeletableSolutionInfo.d.ts

@@ -24,6 +24,6 @@ import { ISolutionPrecis, UserSession } from "./interfaces";
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise resolving to the list of items in the solution that would be deleted.
+ * @returns Promise resolving to the list of items in the solution that would be deleted.
  */
 export declare function getDeletableSolutionInfo(solutionItemId: string, authentication: UserSession): Promise<ISolutionPrecis>;

package/dist/umd/getSolutionSummary.d.ts

@@ -22,6 +22,6 @@ import { ISolutionPrecis, UserSession } from "./interfaces";
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise resolving to a summary of the deployed Solution
+ * @returns Promise resolving to a summary of the deployed Solution
  */
 export declare function getSolutionSummary(solutionItemId: string, authentication: UserSession): Promise<ISolutionPrecis>;