Skip to content

refactor(types): simplify EventMap by removing DefinedEventMap and EventCallbackMap #3237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samuelgja merged 1 commit into from
Mar 18, 2026
Merged

refactor(types): simplify EventMap by removing DefinedEventMap and EventCallbackMap #3237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 8 additions & 19 deletions packages/joint-core/types/joint.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,9 +372,6 @@ export namespace dia {
// custom
[eventName: string]: mvc.EventHandler;
}

type DefinedEventMap = ExcludeIndexSignature<EventMap>;

}

class Graph<A extends ObjectHash = Graph.Attributes, S = dia.ModelSetOptions> extends mvc.Model<A, S> {
Expand All @@ -399,18 +396,18 @@ export namespace dia {

// events

on<T extends keyof Graph.DefinedEventMap>(
on<T extends keyof Graph.EventMap>(
eventName: T,
callback: Graph.DefinedEventMap[T],
callback: Graph.EventMap[T],
context?: any
): this;
on(
eventName: LiteralUnion<keyof Graph.DefinedEventMap>,
eventName: LiteralUnion<keyof ExcludeIndexSignature<Graph.EventMap>>,
callback: mvc.EventHandler,
context?: any
): this;

on<E extends mvc.EventCallbackMap<Graph.DefinedEventMap>>(
on<E extends Partial<Graph.EventMap>>(
events: E,
context?: any
): this;
Expand Down Expand Up @@ -1920,8 +1917,6 @@ export namespace dia {
[eventName: string]: mvc.EventHandler;
}

type DefinedEventMap = ExcludeIndexSignature<EventMap>;

interface BufferOptions {
/**
* A buffer around the area to extend the search to
Expand Down Expand Up @@ -2212,18 +2207,18 @@ export namespace dia {

// events

on<T extends keyof Paper.DefinedEventMap>(
on<T extends keyof Paper.EventMap>(
eventName: T,
callback: Paper.DefinedEventMap[T],
callback: Paper.EventMap[T],
context?: any
): this;
on(
eventName: LiteralUnion<keyof Paper.DefinedEventMap>,
eventName: LiteralUnion<keyof ExcludeIndexSignature<Paper.EventMap>>,
callback: mvc.EventHandler,
context?: any
): this;

on<E extends mvc.EventCallbackMap<Paper.DefinedEventMap>>(
on<E extends Partial<Paper.EventMap>>(
events: E,
context?: any
): this;
Expand Down Expand Up @@ -3642,12 +3637,6 @@ export namespace mvc {
[event: string]: EventHandler;
}

/**
* A partial map of known event callbacks, plus any custom string events.
* Use with a DefinedEventMap to get autocomplete for known events.
*/
type EventCallbackMap<T> = Partial<T> & { [key: string]: EventHandler };

const Events: Events;
interface Events extends EventsMixin {}

Expand Down
Loading