Misnamed key in configuration object for createEntityAdapter

[karptonite]

I'm submitting a...

[ ] Regression (a behavior that used to work and stopped working in a new release)
[x] Bug report  
[ ] Feature request
[ ] Documentation issue or request

This is a follow up for issues #367 and #369. While the documentation now indicates that the sort parameter is a compare function, it is still called sort In the configuration object, which could lead to confusion. It seems worth fixing the name before a beta of the entity package is actually released.

[brandonroberts]

I think sort is clearer, because you either disable it or you provide a custom comparer function used for sorting. I would be more in favor of sort as a pure boolean value and adding an additional property for a custom comparer function.

[karptonite]

Good point. I agree that if you call it compare then setting to false to leave it unsorted is confusing. But it is already optional, so you could leave it unset if you were not sorting. Under what circumstances would you ever want to set it explicitly to false? It seems that of you just had a sortCompare field, and sorted only if sortCompare is set, that may be clear for both usages.

[brandonroberts]

You wouldn't need to explicitly set it to false unless you have it wrapped in some sort of factory. I'm leaning towards leaving it as is for now.

[karptonite]

It is your call. I still think that calling the parameter sort, when what it takes is a custom comparer, is not correct, especially when there is an actual name for what you are passing. It isn't a terrible thing, but what if, down the road, you want to add that sort boolean that you mentioned after all? If you leave it as it is, the parameter name is taken by something that isn't actually sort. Especially if you don't expect it to be used as a boolean, it makes more sense to me to call it what it is.

[brandonroberts]

Valid points. I think sortComparer is closer to describing what the key does. If its false, no sorting will be done, otherwise you provide a function that will be used for sorting.

[karptonite]

I agree that sortComparer is a good name.