@fluidframework/shared-object-base 2.0.0-internal.7.3.0 → 2.0.0-internal.7.4.1

package/src/sharedObject.ts

@@ -40,6 +40,7 @@ import { ISharedObject, ISharedObjectEvents } from "./types";
 
 /**
  * Base class from which all shared objects derive.
+ * @alpha
  */
 export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents>
 	extends EventEmitterWithErrorHandling<TEvent>
@@ -543,9 +544,6 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
 	 * attached to them by the consumers of the DDS). It should not be called from outside the class or to emit events
 	 * which are only internal to the DDS. Support for calling it from outside the DDS instance might be removed in the
 	 * future.
-	 *
-	 * @internal
-	 *
 	 * @param event - The event to emit.
 	 * @param args - Arguments to pass to the event listeners.
 	 * @returns `true` if the event had listeners, `false` otherwise.
@@ -583,6 +581,7 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
 /**
  * SharedObject with simplified, synchronous summarization and GC.
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
+ * @alpha
  */
 export abstract class SharedObject<
 	TEvent extends ISharedObjectEvents = ISharedObjectEvents,

package/src/summarySerializer.ts

@@ -8,6 +8,7 @@ import { FluidSerializer } from "./serializer";
 
 /**
  * Serializer implementation for serializing handles during summary.
+ * @alpha
  */
 export class SummarySerializer extends FluidSerializer {
 	private readonly serializedRoutes: Set<string> = new Set();

package/src/types.ts

@@ -14,6 +14,7 @@ import { IGarbageCollectionData } from "@fluidframework/runtime-definitions";
 
 /**
  * Events emitted by {@link ISharedObject}.
+ * @alpha
  */
 export interface ISharedObjectEvents extends IErrorEvent {
 	/**
@@ -53,6 +54,7 @@ export interface ISharedObjectEvents extends IErrorEvent {
 
 /**
  * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
+ * @alpha
  */
 export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>
 	extends IChannel,

package/src/utils.ts

@@ -16,6 +16,7 @@ import { IFluidSerializer } from "./serializer";
  * @param context - The handle context for the container
  * @param bind - Bind any other handles we find in the object against this given handle.
  * @returns Result of strigifying an object
+ * @internal
  */
 export function serializeHandles(
 	value: any,
@@ -37,6 +38,7 @@ export function serializeHandles(
  * @param context - The handle context for the container
  * @param bind - Bind any other handles we find in the object against this given handle.
  * @returns The fully-plain object
+ * @internal
  */
 export function makeHandlesSerializable(
 	value: any,
@@ -54,6 +56,7 @@ export function makeHandlesSerializable(
  * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects
  * @param context - The handle context for the container
  * @returns The mostly-plain object with handle objects within
+ * @internal
  */
 export function parseHandles(value: any, serializer: IFluidSerializer) {
 	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
@@ -65,6 +68,7 @@ export function parseHandles(value: any, serializer: IFluidSerializer) {
  * @param key - the key for the blob in the summary
  * @param content - blob content
  * @returns The summary containing the blob
+ * @internal
  */
 export function createSingleBlobSummary(
 	key: string,

package/src/valueType.ts

@@ -5,6 +5,7 @@
 
 /**
  * enum representing the possible types of a shared object
+ * @internal
  */
 export enum ValueType {
 	/**