mark stuff as @internal or private to avoid "X does not have any docu…

…mentation" error

if we were to export interfaces instead of classes then we could avoid
this, but such a change feels outside the scope of this work

this is done based on looking at what's mentioned in documentation to
try and guess public interface

src/Cursors.ts

@@ -31,6 +31,7 @@ export default class Cursors extends EventEmitter<CursorsEventMap> {
 
   public channel?: Types.RealtimeChannelPromise;
 
+  /** @internal */
   constructor(private space: Space) {
     super();
 

src/Locations.ts

@@ -18,10 +18,12 @@ type LocationsEventMap = {
 export default class Locations extends EventEmitter<LocationsEventMap> {
   private lastLocationUpdate: Record<string, PresenceMember['data']['locationUpdate']['id']> = {};
 
+  /** @internal */
   constructor(private space: Space, private presenceUpdate: Space['presenceUpdate']) {
     super();
   }
 
+  /** @internal */
   async processPresenceMessage(message: PresenceMember) {
     // Only an update action is currently a valid location update.
     if (message.action !== 'update') return;

src/Locks.ts

@@ -36,6 +36,7 @@ export default class Locks extends EventEmitter<LocksEventMap> {
   // have requested.
   private locks: Map<string, Map<string, Lock>>;
 
+  /** @internal */
   constructor(private space: Space, private presenceUpdate: Space['presenceUpdate']) {
     super();
     this.locks = new Map();
@@ -169,6 +170,7 @@ export default class Locks extends EventEmitter<LocksEventMap> {
     }
   }
 
+  /** @internal */
   async processPresenceMessage(message: Types.PresenceMessage) {
     const member = await this.space.members.getByConnectionId(message.connectionId);
     if (!member) return;
@@ -222,7 +224,7 @@ export default class Locks extends EventEmitter<LocksEventMap> {
   //
   // TODO: remove this once the Ably system processes PENDING requests
   //       internally using this same logic.
-  processPending(member: SpaceMember, pendingLock: Lock) {
+  private processPending(member: SpaceMember, pendingLock: Lock) {
     // if the requested lock ID is not currently locked, then mark the PENDING
     // lock request as LOCKED
     const lock = this.get(pendingLock.id);
@@ -266,18 +268,19 @@ export default class Locks extends EventEmitter<LocksEventMap> {
     pendingLock.reason = ERR_LOCK_IS_LOCKED();
   }
 
-  updatePresence(self: SpaceMember) {
+  private updatePresence(self: SpaceMember) {
     const update = new SpaceUpdate({ self, extras: this.getLockExtras(self.connectionId) });
     return this.presenceUpdate(update.noop());
   }
 
+  /** @internal */
   getLock(id: string, connectionId: string): Lock | undefined {
     const locks = this.locks.get(id);
     if (!locks) return;
     return locks.get(connectionId);
   }
 
-  setLock(lock: Lock) {
+  private setLock(lock: Lock) {
     let locks = this.locks.get(lock.id);
     if (!locks) {
       locks = new Map();
@@ -286,7 +289,7 @@ export default class Locks extends EventEmitter<LocksEventMap> {
     locks.set(lock.member.connectionId, lock);
   }
 
-  deleteLock(id: string, connectionId: string) {
+  private deleteLock(id: string, connectionId: string) {
     const locks = this.locks.get(id);
     if (!locks) return;
     return locks.delete(connectionId);
@@ -306,6 +309,7 @@ export default class Locks extends EventEmitter<LocksEventMap> {
     return requests;
   }
 
+  /** @internal */
   getLockExtras(connectionId: string): PresenceMember['extras'] {
     const locks = this.getLocksForConnectionId(connectionId);
     if (locks.length === 0) return;

src/Members.ts

@@ -22,11 +22,13 @@ class Members extends EventEmitter<MembersEventMap> {
   private lastMemberUpdate: Record<string, PresenceMember['data']['profileUpdate']['id']> = {};
   private leavers: Leavers;
 
+  /** @internal */
   constructor(private space: Space) {
     super();
     this.leavers = new Leavers(this.space.options.offlineTimeout);
   }
 
+  /** @internal */
   async processPresenceMessage(message: PresenceMember) {
     const { action, connectionId } = message;
     const isLeaver = !!this.leavers.getByConnectionId(connectionId);
@@ -103,12 +105,13 @@ class Members extends EventEmitter<MembersEventMap> {
     }
   }
 
+  /** @internal */
   async getByConnectionId(connectionId: string): Promise<SpaceMember | null> {
     const members = await this.getAll();
     return members.find((m) => m.connectionId === connectionId) ?? null;
   }
 
-  createMember(message: PresenceMember): SpaceMember {
+  private createMember(message: PresenceMember): SpaceMember {
     return {
       clientId: message.clientId,
       connectionId: message.connectionId,
@@ -122,7 +125,7 @@ class Members extends EventEmitter<MembersEventMap> {
     };
   }
 
-  async onMemberOffline(member: SpaceMember) {
+  private async onMemberOffline(member: SpaceMember) {
     this.leavers.removeLeaver(member.connectionId);
 
     this.emit('remove', member);

src/Space.ts

@@ -34,7 +34,7 @@ type SpaceEventMap = {
 };
 
 class Space extends EventEmitter<SpaceEventMap> {
-  readonly channelName: string;
+  private readonly channelName: string;
   readonly connectionId: string | undefined;
   readonly options: SpaceOptions;
   readonly locations: Locations;
@@ -44,6 +44,7 @@ class Space extends EventEmitter<SpaceEventMap> {
   readonly locks: Locks;
   readonly name: string;
 
+  /** @internal */
   constructor(name: string, readonly client: Types.RealtimePromise, options?: Subset<SpaceOptions>) {
     super();
 

src/utilities/EventEmitter.ts

@@ -70,9 +70,13 @@ export type EventKey<T extends EventMap> = string & keyof T;
 export type EventListener<T> = (params: T) => void;
 
 export default class EventEmitter<T extends EventMap> {
+  /** @internal */
   any: Array<Function>;
+  /** @internal */
   events: Record<string, Function[]>;
+  /** @internal */
   anyOnce: Array<Function>;
+  /** @internal */
   eventsOnce: Record<string, Function[]>;
 
   constructor() {
@@ -188,6 +192,8 @@ export default class EventEmitter<T extends EventMap> {
   }
 
   /**
+   * @internal
+   *
    * Emit an event
    * @param event the event name
    * @param arg the arguments to pass to the listener
@@ -266,7 +272,7 @@ export default class EventEmitter<T extends EventMap> {
   }
 
   /**
-   * Private API
+   * @internal
    *
    * Listen for a single occurrence of a state event and fire immediately if currentState matches targetState
    * @param targetState the name of the state event to listen to