Skip to content

Commit

Permalink
Update typedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanbliss committed Oct 25, 2024
1 parent ac366c8 commit 34b8084
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/live-share/src/LiveState.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import { TelemetryEvents } from "./internals/consts.js";
import { cloneValue, isNewerEvent } from "./internals/utils.js";

/**
* Events supported by [LiveState` object.
* Events supported by {@link LiveState} object.
*/
export enum LiveStateEvents {
/**
Expand All @@ -36,12 +36,12 @@ export enum LiveStateEvents {
}

/**
* Event typings for `LiveState` class.
* Event typings for {@link LiveState} class.
* @template TState State object that's synchronized with the state.
*/
export interface ILiveStateEvents<TState = any> extends IEvent {
/**
* An `LiveState` objects state has changed.
* An {@link LiveState} objects state has changed.
* @param event Name of event.
* @param listener Function called when event is triggered.
* @param listener.state The new state. Can be the same as the previous state.
Expand Down

0 comments on commit 34b8084

Please sign in to comment.