modelcontextprotocol/typescript-sdk
Watch
1
0
Fork
You've already forked typescript-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

use more strongly typed examples

Browse source
This commit is contained in:
Marcelo Paternostro 2025-04-19 15:28:00 -04:00
commit 94759c3b76
No known key found for this signature in database
1 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/shared/eventNotifier.ts
View file

@ -54,12 +54,12 @@ export type EventNotifier<T, E = Error> = {
* @example
*
* ```ts
* const notifier = createEventNotifier<{ type: string; data: unknown }>();
* const notifier = createEventNotifier<{ type: string; value: number }>();
* notifier.onEvent((event) => {
* console.log(`Received ${event.type} with data:`, event.data);
* console.log(`Received ${event.type} with value:`, event.value);
* });
*
* notifier.notify({ type: 'update', data: { id: 123, status: 'complete' } });
* notifier.notify({ type: 'progress', value: 75 });
* ```
*
* @param event The event to send to all listeners or a function that returns such event.
@ -91,12 +91,15 @@ export type EventNotifier<T, E = Error> = {
* const stringNotifier = createEventNotifier<string>();
*
* // Complex object event notifier
* interface UserEvent {
* type: 'created' | 'updated' | 'deleted';
* userId: number;
* data?: Record<string, unknown>;
* interface TaskEvent {
* type: 'started' | 'completed' | 'failed';
* taskId: number;
* details: {
* name: string;
* duration?: number;
* };
* }
* const userNotifier = createEventNotifier<UserEvent>();
* const taskNotifier = createEventNotifier<TaskEvent>();
* ```
*
* @template T The type of events this notifier will handle