Skip to content

Commit 0c7fb06

Browse files
Extract return value of Space.prototype.getState to its own type
To make it easier to document.
1 parent f820438 commit 0c7fb06

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

src/Space.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ export interface SpaceEventMap {
3434
update: SpaceEvents.UpdateEvent;
3535
}
3636

37+
export interface SpaceState {
38+
members: SpaceMember[];
39+
}
40+
3741
class Space extends EventEmitter<SpaceEventMap> {
3842
/**
3943
* @internal
@@ -184,7 +188,7 @@ class Space extends EventEmitter<SpaceEventMap> {
184188
await this.presenceLeave(data);
185189
}
186190

187-
async getState(): Promise<{ members: SpaceMember[] }> {
191+
async getState(): Promise<SpaceState> {
188192
const members = await this.members.getAll();
189193
return { members };
190194
}

src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Spaces from './Spaces.js';
22

3-
export type { default as Space, SpaceEventMap, SpaceEvents } from './Space.js';
3+
export type { default as Space, SpaceEventMap, SpaceEvents, SpaceState } from './Space.js';
44

55
export type { default as Cursors, CursorsEventMap } from './Cursors.js';
66
export type { default as Locations, LocationsEventMap, LocationsEvents } from './Locations.js';

0 commit comments

Comments
 (0)