feat: added checks on creating events and added method for unregister…

[Mohmn]

…ing events"

fixes #134

[dadiorchen]

@Mohmn did you test this locally?

[RubenSmn]

Maybe instead of a function to remove methods, we can return a unsubscribe method when subscribing on

[Mohmn]

@Mohmn did you test this locally?

Yep i have tested it locally

[Mohmn]

Maybe instead of a function to remove methods, we can return a unsubscribe method when subscribing on

I donot see how it will be helpful, can u state the benefits of it

[dadiorchen]

@RubenSmn you mean like the way of useEffect returning function? if that's the goal, I think the event's once is a good go, just run it one time, then unregiste the lisnter.

[RubenSmn]

I mean these days its a very common pattern to get back a unsubscribe method when subscribing to something.

[Mohmn]

I mean these days its a very common pattern to get back a unsubscribe method when subscribing to something.

Should I do both things
1An explicit function for unsubscribing events
2 returning the unsubscribe function from the subscriber

@dadiorchen @RubenSmn

[RubenSmn]

I feel like its weird to have to call an "extra" method and pass the eventName and the correct handler which means the reference needs to be the same, so I think we can assume that we only add and remove the event in one place in the code if that makes sense.

I think that for the developer experience it is more logical to just receive an unsubscribe when subscribing.

[dadiorchen]

But maybe there are some cases we need to do the unscribe separately?

[RubenSmn]

But maybe there are some cases we need to do the unsubscribe separately?

Our subscriptions are based on the reference of the function, this means we'll always need to provide the reference of the function we ran on a event.

Seperate Method (off)

// Parent
const Parent = () => {
  const myHandler = () => {
    // do stuff
  };

  map.on("this-event", myHandler);

  return (
    <Child handler={myHandler} />
  );
};

// Child
const Child = ({ handler }) => {
  // needs the exact instance of the "handler" function.
  // needs an extra "map" instance
  // needs the "this-event" name
  const onClick = () => {
    map.off("this-event", handler);
  };

  return (
    <button onClick={onClick}>Remove the handler from the map</button>
  );
};

Unsubscribe Method (callback)

// Parent
const Parent = () => {
  const myHandler = () => {
    // do stuff
  };

  const unSubscribe = map.on("this-event", myHandler);

  return (
    <Child unSubscribe={unSubscribe} />
  );
};

// Child
const Child = ({ unSubscribe }) => {
  // only cares about unsubscribing
  const onClick = () => {
    unSubscribe();
  };

  return (
    <button onClick={onClick}>Remove the handler from the map</button>
  );
};

[dadiorchen]

@RubenSmn I'm confused, what's your preference? callback?

[Mohmn]

@dadiorchen i think that @RubenSmn here is trying to imply that whether we use handleoff(implicit unsubscribe method) or callback (subscribe returning unsubscribe), we need to store the reference for it.

[Mohmn]

Ruben's point is now making sense to me , so which way should we go now

[dadiorchen]

@Mohmn let me take some time to understand this

[RubenSmn]

@dadiorchen yes my preference is the callback. I think it will reduce the possibility for errors and provides a better developer experience!