@fluid-experimental/property-common 1.2.2 → 2.0.0-internal.1.0.0.81589

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/property-common",
-  "version": "1.2.2",
+  "version": "2.0.0-internal.1.0.0.81589",
   "description": "common functions used in properties",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -70,7 +70,7 @@
   "devDependencies": {
     "@fluidframework/build-common": "^0.24.0",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "^1.2.2",
+    "@fluidframework/mocha-test-setup": "2.0.0-internal.1.0.0.81589",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/debug": "^4.1.5",

package/platform-dependent/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-internal/platform-dependent",
-  "version": "1.2.2",
+  "version": "2.0.0-internal.1.0.0.81589",
   "private": true,
   "description": "Helper package that separates code for browser and server.",
   "homepage": "https://fluidframework.com",

package/src/consoleUtils.ts

@@ -9,8 +9,8 @@
 export class ConsoleUtils { // eslint-disable-line @typescript-eslint/no-extraneous-class
     /**
      * Throws an error if the in_condition is false
-     * @param  in_condition - the condition we are testing: a boolean expression.
-     * @param  in_message - the error message that will be thrown if the condition is false.
+     * @param in_condition - The condition we are testing: a boolean expression.
+     * @param in_message - The error message that will be thrown if the condition is false.
      */
     static assert(condition: any, message: string | number): asserts condition {
         if (!(condition as boolean)) {

package/src/constants.ts

@@ -1248,7 +1248,7 @@ const PropertyFactoryError = {
     /**
      * methods: PropertyFactory.initializeSchemaStore
      * Warning: The initializeSchemaStore method must be provided with an options object
-                containing a getBearerToken function and the url to the ForgeSchemaService.
+     * containing a getBearerToken function and the url to the ForgeSchemaService.
      */
     MISSING_FSS_INIT_OPTIONS: "PF-065: The initializeSchemaStore method must be provided with an options object " +
         "containing a getBearerToken function and the url to the ForgeSchemaService.",

package/src/datastructures/collection.ts

@@ -144,7 +144,7 @@ export class Collection<T> {
     /**
      * Filter out by function
      * @param in_filterFunction - with arguments key and item
-     * @returns  New filtered collection
+     * @returns A new filtered collection
      */
     filter(in_filterFunction: (key: string, item: T) => boolean): Collection<T> {
         const rtn = new Collection<T>();
@@ -309,9 +309,9 @@ export class Collection<T> {
     /**
      * Set an existing key to a value. If key doesn't exist this call will throw
      * an error.
-     * @param in_key - the key we want to modify
-     * @param  in_value - the value we are to set at this key
-     * @returns the value passed in
+     * @param in_key - The key we want to modify
+     * @param in_value - The value we are to set at this key
+     * @returns The value passed in
      */
     set(in_key: string, in_value: T) {
         this._checkKeyExists(in_key);
@@ -324,7 +324,7 @@ export class Collection<T> {
     /**
      * Iterate over this collection and run the callback with passing the key and
      * item in the iteration loop.
-     * @param  in_callback - a function that we will call on each item
+     * @param in_callback - A function that we will call on each item
      * of this collection. If the callback returns false then the iteration will exit early.
      */
     iterate(in_callback) {

package/src/datastructures/dataArray.ts

@@ -5,8 +5,9 @@
 
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint accessor-pairs: [2, { "getWithoutSet": false }] */
+
 /**
- @fileoverview The data arrays definition file.
+ * The data arrays definition file.
  */
 
 /**
@@ -251,9 +252,9 @@ class BaseDataArray {
     }
 
     /**
-     * change the size of the array
-     * @param size - the target size
-     * @returns  the DataArray itself
+     * Change the size of the array
+     * @param size - The target size
+     * @returns The DataArray itself
      */
     resize(size: number) {   // this can be costly!!!
         this._alloc(size);
@@ -351,9 +352,9 @@ class UniversalDataArray extends BaseDataArray {
     }
 
     /**
-     * insert the content of an array into the DataArray
-     * @param in_offset - the target index
-     * @param  in_array - the array to be inserted
+     * Insert the content of an array into the DataArray
+     * @param in_offset - The target index
+     * @param in_array - The array to be inserted
      */
     insertRange(in_offset: number, in_array: any[]) {
         this._buffer.splice.call(this._buffer, ...[in_offset, 0].concat(in_array));

package/src/datastructures/integer64.ts

@@ -13,6 +13,7 @@ import { constants } from "../constants";
 
 const BIT32 = 4294967296;
 const { MSG } = constants;
+
 /**
  * A data representation class for 64 bit integer types.
  * This is necessary since js doesn't support 64bit
@@ -22,22 +23,22 @@ const { MSG } = constants;
  * There are and there won't be set functions!
  * (see javascript String class)
  *
- * @param low  - lower 32 bit
- * @param high - higher 32 bit
+ * @param low - Lower 32 bit
+ * @param high - Higher 32 bit
  */
 export class Integer64 {
     constructor(protected low = 0, protected high = 0) {
     }
 
     /**
-     * @returns the higher 32 bit integer part
+     * @returns The higher 32 bit integer part
      */
     getValueHigh() {
         return this.high;
     }
 
     /**
-     * @returns the lower 32 bit integer part
+     * @returns The lower 32 bit integer part
      */
     getValueLow() {
         return this.low;
@@ -73,11 +74,11 @@ export class Integer64 {
  * @param in_string - The value to parse. Leading whitespace in the string argument is ignored.
  * @param in_radix - An integer between 2 and 36 that represents the
  *     radix (the base in mathematical numeral systems) of the above mentioned string.
- * @throws if in_string is not a string
- * @throws if in_radix is entered but is not a number between 2 and 36
- * @throws if the property is a Uint64 property and in_string is a negative number
- * @throws if in_string contains characters other than numbers
- * @returns low and high bits of Int64
+ * @throws If in_string is not a string
+ * @throws If in_radix is entered but is not a number between 2 and 36
+ * @throws If the property is a Uint64 property and in_string is a negative number
+ * @throws If in_string contains characters other than numbers
+ * @returns Low and high bits of Int64
  */
 function _stringToInt64(in_signed: boolean, in_string: string, in_radix = 10): number[] {
     ConsoleUtils.assert(_.isString(in_string), MSG.IN_STRING_MUST_BE_STRING + in_string);

package/src/datastructures/sortedCollection.ts

@@ -129,7 +129,7 @@ export class SortedCollection<T> extends Collection<T> {
      * For the given list of keys ['1.0.1', '2.0.0', '2.2.0', '7.0.1'] the nearest next item to 6.0.1 is
      * the item mapped by '7.0.1'
      * @param in_key - The key to check against in order to get the nearest next item
-     * @returns  The nearest next item
+     * @returns The nearest next item
      */
     getNearestNextItem(in_key: string) {
         const closestNextIndex = this._binarySearchNearestIndex(this._sortedKeys, in_key.toString());

package/src/error_objects/flaggedError.ts

@@ -5,9 +5,9 @@
 
 /**
  * Checks if a flag is set
- * @param  flags - flags set within an error object
- * @param  flag - A flag to be checked
- * @returns   True if the flag is set in passed flags, false otherwise.
+ * @param flags - Flags set within an error object
+ * @param flag - A flag to be checked
+ * @returns True if the flag is set in passed flags, false otherwise.
  */
  const _isFlagSet = (flags: number, flag: number) => {
     // eslint-disable-next-line no-bitwise

package/src/guidUtils.ts

@@ -37,9 +37,8 @@ const guidRNG = {
      *                           local time and Math.random() is used.
      * @param in_enforceReInitialization - Optionally enforce re-initialization with another seed
      *
-     * @returns  The seed used to initialize the RNG;
-     *          If re-initialization is not enforced,
-     *          a zero indicates that the RNG was not re-seeded.
+     * @returns The seed used to initialize the RNG;
+     * If re-initialization is not enforced, a zero indicates that the RNG was not re-seeded.
      * @alias property-common.initializeGUIDGenerator
      */
     initialize(in_seed?: number, in_enforceReInitialization: boolean = false): number {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluid-experimental/property-common";
-export const pkgVersion = "1.2.2";
+export const pkgVersion = "2.0.0-internal.1.0.0.81589";