diff --git a/packages/framework/presence/src/presence.ts b/packages/framework/presence/src/presence.ts index 7e89213bb26c..71d097457753 100644 --- a/packages/framework/presence/src/presence.ts +++ b/packages/framework/presence/src/presence.ts @@ -31,17 +31,28 @@ import type { ISubscribable } from "@fluid-experimental/presence/internal/events export type ClientSessionId = SessionId & { readonly ClientSessionId: "ClientSessionId" }; /** - * The connection status of the {@link ISessionClient}. + * An object containing the possible connection statuses of an {@link ISessionClient}. * * @alpha */ export const SessionClientStatus = { + /** + * The session client is connected to the delta stream. + * Can send to and receive updates from other session clients. + */ Connected: "Connected", + /** + * The session client is not connected to the delta stream. + * Cannot send to or receive updates from other session clients. + */ Disconnected: "Disconnected", } as const; /** - * Type for the connection status of the {@link ISessionClient}. + * Represents the connection status of an {@link ISessionClient}. + * + * This type can be either `'Connected'` or `'Disconnected'`, indicating whether + * the session client is currently able to send and receive updates. * * @alpha */ diff --git a/packages/framework/presence/src/systemWorkspace.ts b/packages/framework/presence/src/systemWorkspace.ts index 32d63aea9d92..6237e1f54b93 100644 --- a/packages/framework/presence/src/systemWorkspace.ts +++ b/packages/framework/presence/src/systemWorkspace.ts @@ -7,13 +7,13 @@ import { assert } from "@fluidframework/core-utils/internal"; import type { ClientConnectionId } from "./baseTypes.js"; import type { InternalTypes } from "./exposedInternalTypes.js"; -import { - SessionClientStatus, - type ClientSessionId, - type IPresence, - type ISessionClient, - type PresenceEvents, +import type { + ClientSessionId, + IPresence, + ISessionClient, + PresenceEvents, } from "./presence.js"; +import { SessionClientStatus } from "./presence.js"; import type { PresenceStatesInternal } from "./presenceStates.js"; import type { PresenceStates, PresenceStatesSchema } from "./types.js";