@fluidframework/tree 2.70.0-360374 → 2.70.0-361092

package/src/util/index.ts

@@ -78,7 +78,7 @@ export {
 	assertNonNegativeSafeInteger,
 	objectToMap,
 	invertMap,
-	oneFromSet,
+	oneFromIterable,
 	type Named,
 	compareNamed,
 	disposeSymbol,

package/src/util/utils.ts

@@ -105,6 +105,28 @@ export function iterableHasSome<T>(iterable: Iterable<T>): boolean {
 	return iterable[Symbol.iterator]().next().done === false;
 }
 
+/**
+ * Returns the value from the given iterable if it contains exactly one item, otherwise `undefined`.
+ * @remarks
+ * Note that if the iterable itself may contain `undefined` values,
+ * it is not possible to use this to distinguish between an iterable that contains exactly one `undefined` value and an iterable that contains zero or multiple values.
+ */
+export function oneFromIterable<T>(items: Iterable<T>): T | undefined {
+	const iterator = items[Symbol.iterator]();
+	const first = iterator.next();
+	if (first.done === true) {
+		// Empty iterable case.
+		return undefined;
+	}
+	const second = iterator.next();
+	if (second.done === true) {
+		// Single item iterable case.
+		return first.value;
+	}
+	// Multiple item iterable case.
+	return undefined;
+}
+
 /**
  * Returns true if and only if the given array has exactly one element.
  * @param array - The array to check.
@@ -291,7 +313,11 @@ export function count(iterable: Iterable<unknown>): number {
  * @remarks
  * This does not robustly forbid non json comparable data via type checking,
  * but instead mostly restricts access to it.
- * @alpha
+ *
+ * @privateRemarks
+ * TODO (before promoting to public): consider moving this to a more general location - this isn't SharedTree-specific.
+ *
+ * @beta
  */
 export type JsonCompatible<TExtra = never> =
 	| string
@@ -305,10 +331,15 @@ export type JsonCompatible<TExtra = never> =
 
 /**
  * Use for Json object compatible data.
+ *
  * @remarks
  * This does not robustly forbid non json comparable data via type checking,
  * but instead mostly restricts access to it.
- * @alpha
+ *
+ * @privateRemarks
+ * TODO (before promoting to public): consider moving this to a more general location - this isn't SharedTree-specific.
+ *
+ * @beta
  */
 export type JsonCompatibleObject<TExtra = never> = { [P in string]?: JsonCompatible<TExtra> };
 
@@ -468,21 +499,6 @@ export function invertMap<Key, Value>(input: Map<Key, Value>): Map<Value, Key> {
 	return result;
 }
 
-/**
- * Returns the value from `set` if it contains exactly one item, otherwise `undefined`.
- */
-export function oneFromSet<T>(set: ReadonlySet<T> | undefined): T | undefined {
-	if (set === undefined) {
-		return undefined;
-	}
-	if (set.size !== 1) {
-		return undefined;
-	}
-	for (const item of set) {
-		return item;
-	}
-}
-
 /**
  * Type with a name describing what it is.
  * Typically used with values (like schema) that can be stored in a map, but in some representations have their name/key as a field.