feat: add lengthEq and lengthNotEq #552
Conversation
|
CI is complaining about some jsdoc problems.
IMHO is absolutely ok to return false in cases like these. |
It's strange -
OK. |
|
@char0n Btw don't feel you have to review this if you want to get a release out today. It can wait for the next release - just wanted to close out the remaining functions in that issue and thought it made sense for them all to go in the same release. But I don't think anyone will lose sleep if they don't. |
src/lengthEq.js
Outdated
| * @param {number} valueLength The length of the list or string | ||
| * @param {number} value The list or string | ||
| * @return {boolean} | ||
| * @see {@link http://ramdajs.com/docs/#equals|equals}, |
There was a problem hiding this comment.
@see is on multiple lines, should be on one line, or prettier is doing this?
src/lengthEq.js
Outdated
| * @category List | ||
| * @sig Number -> [*] -> Boolean | ||
| * @param {number} valueLength The length of the list or string | ||
| * @param {number} value The list or string |
There was a problem hiding this comment.
@param {Array|string} value ...
This also apply to all the length* functions that you did before. Include changes to these function into this PR.
src/lengthNotEq.js
Outdated
| * @param {number} valueLength The length of the list or string | ||
| * @param {number} value The list or string | ||
| * @return {boolean} | ||
| * @see {@link http://ramdajs.com/docs/#equals|equals}, |
src/lengthNotEq.js
Outdated
| * @category List | ||
| * @sig Number -> [*] -> Boolean | ||
| * @param {number} valueLength The length of the list or string | ||
| * @param {number} value The list or string |
There was a problem hiding this comment.
@param {Array|string} value ...
This also apply to all the length* functions that you did before. Include changes to these function into this PR.
test/lengthEq.js
Outdated
| import eq from './shared/eq'; | ||
|
|
||
| describe('lengthEq', function() { | ||
| it(`should return true if the length of a list is equal to the supplied length`, function() { |
There was a problem hiding this comment.
context('when the length of a list is equal to the supplied length', function() {
specify('should return true', function() {
...
});
});
test/lengthEq.js
Outdated
| eq(RA.lengthEq(0, []), true); | ||
| }); | ||
|
|
||
| it(`should return true if the length of a string is equal to the supplied length`, function() { |
There was a problem hiding this comment.
context('the length of a string is equal to the supplied length', function() {
specify('should return true', function() {
...
});
});
test/lengthEq.js
Outdated
| eq(RA.lengthEq(0, ''), true); | ||
| }); | ||
|
|
||
| it(`should return false for values without a length property`, function() { |
There was a problem hiding this comment.
context('when there are values without a length property', function() {
specify('should return false', function() {
...
});
});|
@Undistraction to late, I already did it ;] It looks nice, we need just need to do some improvements here. I need |
|
I've also added @see refs to each of the other |
There was a problem hiding this comment.
Looks good! One note: you're using string template literals to provide descriptions for tests. I didn't even know that our codestyle allows that. This means that we are not consistent with the way we write our tests. Rest of the team is using normal strings to describe tests. We must do something about it.
Update:
I confirm, you started to use this convention on RA.move and everything after it.
|
Ah sorry. I use literals for everything as it means I can interpolate into stings without changing the delimiters which is quicker and better for seeing changes in diffs so I'm doing it out of habit. Obviously I'll try and remember to use normal delimeters but there should be a way of longing for it. I'll put together a PR switching to normal delimeters and look at how to lint for my use of backticks. |
|
This PR can go inside. We'll deal with the string literals in #553. |
Adds remaining functions to test of list or string length is equal or notEqual to the supplied length.
Note: I'm unsure of the correct behaviour for
lengthNotEqwhen the value supplied does not have a length property. I am returning false, but should we do something else?Closes #444