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.

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

added fq() for passing in an object or multiple filters #241

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
28 changes: 28 additions & 0 deletions lib/query.js
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,34 @@ Query.prototype.matchFilter = function (field, value) {
return self;
};

/**
* wrapper function for matchFilter, accepting either an object with `field` and `value` properties
* or an array containing such objects to be mapped on matchFilter
*
* @param {Object|Array} filters - Object or an array of objects with `field` and `value` properties
*
* @return {Query}
*
* @throws {Error}
* @api public
*
* @example
* var query = client.createQuery();
* query.q({ '*' : '*' }).fq({field: 'id', value: 100})
* query.q({ '*' : '*' }).fq([{field: 'id', value: 100}, {field: 'name', value: 'John'}])
*/
Query.prototype.fq = function (filters) {
const self = this
if (filters instanceof Array) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Array.isArray is the standard way to check this, I believe

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done 👍

filters.map(f => this.matchFilter(f.field, f.value))
return self
}
if (filters instanceof Object) return this.matchFilter(filters.field, filters.value)
else {
throw new Error('unknown type for filter in fq()')
}
}

/**
* Specify a set of fields to return.
*
Expand Down
38 changes: 38 additions & 0 deletions test/core-query-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -266,5 +266,43 @@ describe('Client#createQuery', function () {
done();
});
});

it('query with multiple match-filters', function (done) {
const query = client
.createQuery()
.q('*:*')
.fq([{field: 'id', value: '19700506.173.85'}, {field: 'title', value: 'testvalue'}])
.debugQuery();

client.search(query, function (err, data) {
sassert.ok(err, data);
assert.deepEqual(data.responseHeader.params, {
debugQuery: 'true',
q: '*:*',
fq: ['id:19700506.173.85', 'title:testvalue'],
wt: 'json',
});
done();
});
});

it('query with object match-filter', function (done) {
const query = client
.createQuery()
.q('*:*')
.fq({field: 'id', value: '19700506.173.85'})
.debugQuery();

client.search(query, function (err, data) {
sassert.ok(err, data);
assert.deepEqual(data.responseHeader.params, {
debugQuery: 'true',
q: '*:*',
fq: 'id:19700506.173.85',
wt: 'json',
});
done();
});
});
});
});