Document queryParamsDidChange

[danfinlay]

Right now Ember.Route has an action queryParamsDidChange that is triggered when query params change.

This is useful when needing to override the usual query-param-changing behavior.

However, this method is not in the ember docs, I had to find mention of it in a discussion online.

[hparra]

👍 Search to find in source turned this issue up.

See

ember.js/packages/ember-routing/lib/system/route.js

Line 665 in b80d66f

queryParamsDidChange(changed, totalPresent, removed) {

[Gaurav0]

@rwjblue @stefanpenner Is this method intended to be public or private?

[rwjblue]

@Gaurav0 - I am unsure, we likely need to ask @machty....

[elidupuis]

FWIW, I'd like it to be public :D

[stefanpenner]

i suspect public, but @machty may be able to shed light. Will rope him in.

[machty]

I don't think I ever intended queryParamsDidChange to be public. It was needed as part of the somewhat convoluted contract with using router.js as a microlib, but it ended up serving as an escape hatch for folk who had unusual serialization/default needs while we figured out the correct APIs to build into Ember. I'd vote to keep it private, but we should start collecting feedback as to how people are using queryParamsDidChange for the next iteration of query params (probably as part of a routing service).

[elidupuis]

👍 to QP support in a routing service.

Currently, I'm basically using my own service to keep track of QPs. When they get set by user action I can easily intercept and update my service directly—at the same time as setting the controller properties that are bound to the URL. However, queryParamsDidChange is proving to be very useful on page load as it allows me to get my service up-to-date immediately. I tried doing this on controller.init instead but the QPs all still have their default value instead of what's in the URL.

I suppose all of this is moot if there was a standard routing service that held all this info.

[rwjblue]

@knownasilya's service addon is pretty nice for this: https://github.com/knownasilya/ember-query-params. It is good to feel out the space of using a service for this, so we can learn the best patterns and try to incorporate them upstream...

[elidupuis]

Cool. I'll take a look.

[knownasilya]

but we should start collecting feedback as to how people are using queryParamsDidChange for the next iteration of query params (probably as part of a routing service).

@machty I'm currently using that action for that exact purpose, see the link that @rwjblue posted above.

[knownasilya]

This can be closed, #13398 was merged.

[michaelklopf]

What is the current state for queryParamsDidChange? Docs were added for the feature, but it's still private and possible to vanish at some point?

[knownasilya]

I think it's called intimate API, meaning people are using it, so most likely there would be a deprecation if it was to go away before they removed it. So you'd at least have some warning if using it.