Truncation returning incorrect results

Truncation returning incorrect results

[millermedeiros]

the length is including the append, I forgot to add it to the markdown docs: @param {number} [maxChars] Default to 125 chars. (including append.length)

maybe I should change the logic to: str = str.substr(0, maxChars + 1); - it will avoid confusions, just need to be aware that it will potentially return a string larger than maxChars..

[millermedeiros]

the tests for truncate(): https://github.com/millermedeiros/amd-utils/blob/bad26b87df/tests/spec/spec-string.js#L32-56 - I'm sure it is working properly, it may just not be the output you expected.

Below is a modified snippet that outputs expected results. Instead of trim() at the beginning, I moved after the first string.substr() and removed your second string.substr()

function truncate(str, maxChars, append){
    maxChars = maxChars || 125;
    append = append || '...';

    if(str.length <= maxChars){
        return str;
    }
    str = str.substr(0, maxChars - append.length + 1);

    // Lets trim after the text has been substr
    str = str = trim(str);
    return str + append;
}

function trim(str){
    return (str || '').replace(/^\s+|\s+$/g, '');
}

truncate('Lorem ipsum dolor sit amet', 6); // Lore...
truncate('Lorem ipsum dolor sit amet', 7); // Lorem...
truncate('Lorem ipsum dolor sit amet', 13); // Lorem ipsum...

[millermedeiros]

on your version the returned string is 1 char larger than maxChars: "Lore..." is 7 chars long...

I will add an option to truncate at the middle of a word (like your implementation) or only keep full words (like current implementation). Probably will create a new method instead of adding a boolean flag toggle behavior..

[millermedeiros]

changed the way truncate works and added a new alias crop: f6bf7cd

thanks for reporting..