Extract type of updateProfileData’s function param

I didn’t really want to do this, but with the TypeDoc configuration that
I intend to use (i.e. with `"validation": true` and
`requiredToBeDocumented` populated with all types) it seems unavoidable,
else I get an error of the form

> [warning] Space.updateProfileData.updateFn.__type, defined in ./dist/mjs/Space.d.ts, does not have any documentation.

I could not figure out how to satisfy this warning without creating a
type for this callback. I think that in a codebase which makes heavy use
of callbacks this would not be ideal, but I guess we can live with it in
our codebase, where there are few callbacks.

The alternative would be to try and change the TypeDoc configuration,
but I couldn’t find a non-trivial requiredToBeDocumented value which
made the warning go away. And I don’t really want to make
requiredToBeDocumented trivial nor turn off the `validation` option.

It’s a shame that, as far as I can tell, TypeDoc doesn’t offer the
option of suppressing a warning for a single symbol.

Author: lawrence-forooghian

src/Space.ts

@@ -38,6 +38,8 @@ export interface SpaceState {
   members: SpaceMember[];
 }
 
+export type UpdateProfileDataFunction = (profileData: ProfileData) => ProfileData;
+
 class Space extends EventEmitter<SpaceEventMap> {
   /**
    * @internal
@@ -142,8 +144,8 @@ class Space extends EventEmitter<SpaceEventMap> {
   }
 
   async updateProfileData(profileData: ProfileData): Promise<void>;
-  async updateProfileData(updateFn: (update: ProfileData) => ProfileData): Promise<void>;
-  async updateProfileData(profileDataOrUpdateFn: ProfileData | ((update: ProfileData) => ProfileData)): Promise<void> {
+  async updateProfileData(updateFn: UpdateProfileDataFunction): Promise<void>;
+  async updateProfileData(profileDataOrUpdateFn: ProfileData | UpdateProfileDataFunction): Promise<void> {
     const self = await this.members.getSelf();
 
     if (!isObject(profileDataOrUpdateFn) && !isFunction(profileDataOrUpdateFn)) {

src/index.ts

@@ -1,6 +1,6 @@
 import Spaces from './Spaces.js';
 
-export type { default as Space, SpaceEventMap, SpaceEvents, SpaceState } from './Space.js';
+export type { default as Space, SpaceEventMap, SpaceEvents, SpaceState, UpdateProfileDataFunction } from './Space.js';
 
 export type { default as Cursors, CursorsEventMap } from './Cursors.js';
 export type { default as Locations, LocationsEventMap, LocationsEvents } from './Locations.js';