jQuery.Event doc does not mention .isTrigger

[2is10]

http://api.jquery.com/category/events/event-object/

It's often helpful to distinguish whether an event handler was triggered programmatically via .trigger or .triggerHandler. The .isTrigger property on jQuery.Event objects seems to be provided for exactly that purpose. It would be more discoverable if the API docs mentioned it.

Currently, the top answer to this question on stackoverflow is a bit more verbose: event.originalEvent === undefined

[dmethvin]

At the moment, event.isTrigger is undefined and its semantics actually changed a bit recently so I'm not sure it's ready to be part of the public API with a guarantee of stability. Checking for event.originalEvent is a good way since that is only set if the event originated from the browser.

[kswedberg]

In that case, I think it's a good idea to hold off on documenting this. @dmethvin, feel free to reopen this or open another issue if/when you think this is ready to be made public.

[MacroMan]

With this property still available, is it now time to actually document this feature?

[AurelioDeRosa]

@dmethvin I'm reopening this issue to get your input here. If this is something not meant for public use, feel free to close it again.

[dmethvin]

We've been talking about trying to use the native event object for jQuery 4, in which case we wouldn't be pushing foreign properties into it. I still think that in most cases there are better ways to detect this that don't require jQuery internals.

[MacroMan]

Would it be wise to document the recommended/better way to achieve this? I've had to use this property several times now.

[dmethvin]

Ideally you'd ask that question on StackOverflow, it's not a question that would be answered by API docs since it's a "how do I..." instead of one asking how a particular API works.

As for how, it depends on what you're doing. A simple case might be

$("p").on("click fake_click", function( e ) { 
   if ( e.type === "fake_click" ) ...
}).trigger("fake_click");

[MacroMan]

I agree. Feel free to close the ticket again.