@fluidframework/fluid-static 1.1.0 → 1.2.0

package/src/serviceAudience.ts

@@ -17,6 +17,9 @@ import { IServiceAudience, IServiceAudienceEvents, IMember } from "./types";
 export abstract class ServiceAudience<M extends IMember = IMember>
   extends TypedEventEmitter<IServiceAudienceEvents<M>>
   implements IServiceAudience<M> {
+  /**
+   * Audience object which includes all the existing members of the container.
+   */
   protected readonly audience: IAudience;
 
   /**
@@ -33,7 +36,10 @@ export abstract class ServiceAudience<M extends IMember = IMember>
   protected lastMembers: Map<string, M> = new Map();
 
   constructor(
-      protected readonly container: IContainer,
+    /**
+     * Fluid Container to read the audience from.
+     */
+    protected readonly container: IContainer,
   ) {
     super();
     this.audience = container.audience;
@@ -60,6 +66,10 @@ export abstract class ServiceAudience<M extends IMember = IMember>
     this.container.on("connected", () => this.emit("membersChanged"));
   }
 
+  /**
+   * Provides ability for inheriting class to modify/extend the audience object.
+   * @param audienceMember - Record of a specific audience member.
+   */
   protected abstract createServiceMember(audienceMember: IClient): M;
 
   /**
@@ -114,6 +124,11 @@ export abstract class ServiceAudience<M extends IMember = IMember>
     return member;
   }
 
+  /**
+   * Provides ability for the inheriting class to include/omit specific members.
+   * An example use case is omitting the summarizer client.
+   * @param member - Member to be included/omitted.
+   */
   protected shouldIncludeAsMember(member: IClient): boolean {
     // Include only human members
     return member.details.capabilities.interactive;

package/src/types.ts

@@ -54,9 +54,10 @@ export type LoadableObjectCtor<T extends IFluidLoadable> = new(...args: any[]) =
  */
 export interface ContainerSchema {
     /**
-     * initialObjects defines loadable objects that will be created when the Container
-     * is first created. It uses the key as the id and the value as the loadable object to create.
+     * Defines loadable objects that will be created when the `Container` is first created.
+     * It uses the key as the id and the value as the loadable object to create.
      *
+     * @example
      * In the example below two objects will be created when the Container is first
      * created. One with id "map1" that will return a `SharedMap` and the other with
      * id "pair1" that will return a `KeyValueDataObject`.
@@ -83,12 +84,16 @@ export interface ContainerSchema {
 
 /**
  * Events that trigger when the roster of members in the Fluid session change.
- * Only changes that would be reflected in the returned map of IServiceAudience's getMembers method
- * will emit events.
+ * Only changes that would be reflected in the returned map of {@link IServiceAudience}'s
+ * {@link IServiceAudience.getMembers} method will emit events.
+ *
+ * @remarks
+ *
+ * The following is the list of events emitted.
  *
  * ### "membersChanged"
  *
- * The membersChanged event is emitted when a member is either added or removed.
+ * The "membersChanged" event is emitted when a member is either added or removed.
  *
  * #### Listener signature
  *
@@ -98,7 +103,7 @@ export interface ContainerSchema {
  *
  * ### "memberAdded"
  *
- * The memberAdded event is emitted when a member joins the audience.
+ * The "memberAdded" event is emitted when a member joins the audience.
  *
  * #### Listener signature
  *
@@ -111,7 +116,7 @@ export interface ContainerSchema {
  *
  * ### "memberRemoved"
  *
- * The memberRemoved event is emitted when a member leaves the audience.
+ * The "memberRemoved" event is emitted when a member leaves the audience.
  *
  * #### Listener signature
  *