Ability to specify whether null records should be first or last when sorting.

[Elbarae1921]

Closes #267.

I believe this is the official "typeorm" way of doing it (typeorm/typeorm#685). I think it doesn't work on all databases but that's for the typeorm project to worry about.

query.addOrderBy('record.field', 'ASC', 'NULLS LAST');

I added a new test closure for the new functionality, LMK if maybe there should be more, I also updated the readme.

[codecov]

Codecov Report

Merging #296 (5abdeed) into master (f7d0eb4) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #296      +/-   ##
==========================================
+ Coverage   95.74%   95.76%   +0.01%     
==========================================
  Files           5        5              
  Lines         235      236       +1     
  Branches       79       80       +1     
==========================================
+ Hits          225      226       +1     
  Misses          9        9              
  Partials        1        1              

Impacted Files	Coverage Δ
src/paginate.ts	96.47% <100.00%> (+0.02%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[Elbarae1921]

This is what the config looks like now

return paginate(query, dataRepository, {
      sortableColumns: ['id', 'name', 'color', 'age'],
      nullSort: 'last', // <--- new field
      searchableColumns: ['name', 'color', 'age'],
      defaultSortBy: [['id', 'DESC']],
      filterableColumns: {
        age: [FilterOperator.GTE, FilterOperator.LTE],
      },
});

Initially I thought it would be useful to have it in the query instead, like:

&sortBy=color:DESC:NULLS LAST

But it seems more fitting for it to be a config, as it's not something I imagine you'd change often.
Let me know what you think.

[ppetzold]

Agree with everything.

LGTM 🌟

[ppetzold]

🎉 This PR is included in version 4.2.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[ppetzold]

@Elbarae1921 Ah sorry, just looking at it after merging:

• readme says default is last, code defaults to first tho
• what was the default before this PR?
• can you add a test with first as well?

[Elbarae1921]

@ppetzold my bad. Initially, I set last as default but since the default behavior before was first, I changed it but forgot to change the readme after.

Sure, I can. Would have to open a new PR tho right?

[ppetzold]

@ppetzold my bad. Initially, I set last as default but since the default behavior before was first, I changed it but forgot to change the readme after.

Sure, I can. Would have to open a new PR tho right?

Yes pls :)

[a-soppe-emit]

#296 (comment) I believe this is the official "typeorm" way of doing it (typeorm/typeorm#685). I think it doesn't work on all databases but that's for the typeorm project to worry about.

You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'NULLS FIRST LIMIT 20' at line 1

Version 4.2.0 sadly breaks pagination when using MySQL. Invalid syntax NULLS FIRST/LAST is not stripped out by TypeORM for databases like MySQL.

Reverted back to 4.1.0 for now.

[ppetzold]

#296 (comment) I believe this is the official "typeorm" way of doing it (typeorm/typeorm#685). I think it doesn't work on all databases but that's for the typeorm project to worry about.

You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'NULLS FIRST LIMIT 20' at line 1

Version 4.2.0 sadly breaks pagination when using MySQL. Invalid syntax NULLS FIRST/LAST is not stripped out by TypeORM for databases like MySQL.

Reverted back to 4.1.0 for now.

@Elbarae1921 Can you remove the default then / only append to query if set? And add in comment/README that not all database types are supported?