@fluidframework/container-runtime 2.70.0-361092 → 2.70.0-361248

package/dist/containerRuntime.d.ts

@@ -581,7 +581,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      * Api to fetch the snapshot from the service for a loadingGroupIds.
      * @param loadingGroupIds - LoadingGroupId for which the snapshot is asked for.
      * @param pathParts - Parts of the path, which we want to extract from the snapshot tree.
-     * @returns - snapshotTree and the sequence number of the snapshot.
+     * @returns snapshotTree and the sequence number of the snapshot.
      */
     getSnapshotForLoadingGroupId(loadingGroupIds: string[], pathParts: string[]): Promise<{
         snapshotTree: ISnapshotTree;
@@ -593,7 +593,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      * @param pathParts - Part of the path, which we want to extract from the snapshot tree.
      * @param hasIsolatedChannels - whether the channels are present inside ".channels" subtree. Older
      * snapshots will not have trees inside ".channels", so check that.
-     * @returns - requested snapshot tree based on the path parts.
+     * @returns requested snapshot tree based on the path parts.
      */
     private getSnapshotTreeForPath;
     /**
@@ -698,7 +698,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     /**
      * Flush the current batch of ops to the ordering service for sequencing
      * This method is not expected to be called in the middle of a batch.
-     * @remarks - If it throws (e.g. if the batch is too large to send), the container will be closed.
+     * @remarks If it throws (e.g. if the batch is too large to send), the container will be closed.
      *
      * @param resubmitInfo - If defined, indicates this is a resubmission of a batch with the given Batch info needed for resubmit.
      */
@@ -771,7 +771,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
     /**
      * Builds the Summary tree including all the channels and the container state.
      *
-     * @remarks - Unfortunately, this function is accessed in a non-typesafe way by a legacy first-party partner,
+     * @remarks Unfortunately, this function is accessed in a non-typesafe way by a legacy first-party partner,
      * so until we can provide a proper API for their scenario, we need to ensure this function doesn't change.
      */
     private summarizeInternal;
@@ -905,7 +905,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
      * Emit "dirty" or "saved" event based on the current dirty state of the document.
      * This must be called every time the states underlying the dirty state change.
      *
-     * @privateRemarks - It's helpful to think of this as an event handler registered
+     * @privateRemarks It's helpful to think of this as an event handler registered
      * for hypothetical "changed" events for PendingStateManager, Outbox, and Container Attach machinery.
      * But those events don't exist so we manually call this wherever we know those changes happen.
      */

package/dist/containerRuntime.js

@@ -1259,7 +1259,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
      * Api to fetch the snapshot from the service for a loadingGroupIds.
      * @param loadingGroupIds - LoadingGroupId for which the snapshot is asked for.
      * @param pathParts - Parts of the path, which we want to extract from the snapshot tree.
-     * @returns - snapshotTree and the sequence number of the snapshot.
+     * @returns snapshotTree and the sequence number of the snapshot.
      */
     async getSnapshotForLoadingGroupId(loadingGroupIds, pathParts) {
         const sortedLoadingGroupIds = loadingGroupIds.sort();
@@ -1342,7 +1342,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
      * @param pathParts - Part of the path, which we want to extract from the snapshot tree.
      * @param hasIsolatedChannels - whether the channels are present inside ".channels" subtree. Older
      * snapshots will not have trees inside ".channels", so check that.
-     * @returns - requested snapshot tree based on the path parts.
+     * @returns requested snapshot tree based on the path parts.
      */
     getSnapshotTreeForPath(snapshotTree, pathParts, hasIsolatedChannels) {
         let childTree = snapshotTree;
@@ -2074,7 +2074,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     /**
      * Flush the current batch of ops to the ordering service for sequencing
      * This method is not expected to be called in the middle of a batch.
-     * @remarks - If it throws (e.g. if the batch is too large to send), the container will be closed.
+     * @remarks If it throws (e.g. if the batch is too large to send), the container will be closed.
      *
      * @param resubmitInfo - If defined, indicates this is a resubmission of a batch with the given Batch info needed for resubmit.
      */
@@ -2281,7 +2281,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     /**
      * Builds the Summary tree including all the channels and the container state.
      *
-     * @remarks - Unfortunately, this function is accessed in a non-typesafe way by a legacy first-party partner,
+     * @remarks Unfortunately, this function is accessed in a non-typesafe way by a legacy first-party partner,
      * so until we can provide a proper API for their scenario, we need to ensure this function doesn't change.
      */
     async summarizeInternal(fullTree, trackState, telemetryContext) {
@@ -2823,7 +2823,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
      * Emit "dirty" or "saved" event based on the current dirty state of the document.
      * This must be called every time the states underlying the dirty state change.
      *
-     * @privateRemarks - It's helpful to think of this as an event handler registered
+     * @privateRemarks It's helpful to think of this as an event handler registered
      * for hypothetical "changed" events for PendingStateManager, Outbox, and Container Attach machinery.
      * But those events don't exist so we manually call this wherever we know those changes happen.
      */