Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

When using esb.sort().script(...) #78

Merged
merged 13 commits into from
Nov 20, 2018
Merged

When using esb.sort().script(...) #78

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
390ac84
When using esb.sort().script(...)
Nov 19, 2018
7c6523e
Update index.d.ts
Nov 19, 2018
48cc1dd
Update sort.js
Nov 19, 2018
19d0f77
Update index.d.ts
Nov 19, 2018
1395b2d
Update index.d.ts
Nov 19, 2018
b72c369
Update sort.js
Nov 19, 2018
7cae034
Update sort.js
Nov 19, 2018
f38e33c
Update index.d.ts
Nov 19, 2018
a3b6980
Update index.d.ts
Nov 19, 2018
e1daa89
Update index.d.ts
Nov 19, 2018
9075c9d
Update sort.js
Nov 19, 2018
89141d0
Update index.d.ts
Nov 19, 2018
363c23a
Set field only if it is not nil.
sudo-suhas Nov 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/core/sort.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ const invalidUnitParam = invalidParam(ES_REF_URL, 'unit', UNIT_SET);
* .query(esb.termQuery('user', 'kimchy'))
* .sort(esb.sort('post_date', 'asc'))
*
* @param {string} field The field to sort on
* @param {string=} field The field to sort on.
* If `.script()` function is used, It will be omitted.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be reworded as

Suggested change
* If `.script()` function is used, It will be omitted.
* If a script is used to specify the sort order, `field` should be omitted.

Could you please do these changes in the 3 places? I apologise for the redundancy, I am planning to do something about it sometime soon.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's so easy. 😄

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that it's easy but it's also easy to miss and not obvious that the same changes have to made in multiple places. Nevertheless, I appreciate your patience and cooperation.

* @param {string=} order The `order` option can have the following values.
* `asc`, `desc` to sort in ascending, descending order respectively.
*/
Expand Down
12 changes: 7 additions & 5 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8258,13 +8258,14 @@ declare namespace esb {
/**
* Allows creating and configuring sort on specified field.
*
* @param {string} field The field to sort on
* @param {string=} field The field to sort on.
* If `.script()` function is used, It will be omitted.
* @param {string=} order The `order` option can have the following values.
* `asc`, `desc` to sort in ascending, descending order respectively.
*/
export class Sort {
constructor(field: string, order?: string);

constructor(field?: string, order?: string);
/**
* Set order for sorting. The order defaults to `desc` when sorting on the `_score`,
* and defaults to `asc` when sorting on anything else.
Expand Down Expand Up @@ -8417,11 +8418,12 @@ declare namespace esb {
/**
* Allows creating and configuring sort on specified field.
*
* @param {string} field The field to sort on
* @param {string=} field The field to sort on.
* If `.script()` function is used, It will be omitted.
* @param {string=} order The `order` option can have the following values.
* `asc`, `desc` to sort in ascending, descending order respectively.
*/
export function sort(field: string, order?: string): Sort;
export function sort(field?: string, order?: string): Sort;

/**
* A `rescore` request can help to improve precision by reordering just
Expand Down