Revision as of 23:12, 9 January 2015

splitArgs is designed to assist other scripts in handling user input. In particular, the common practice of creating an API command followed by a series of parameters means that the single string represented by msg.content needs to be split into multiple parts. The naive and most common means of doing this is simply using msg.content.split(' '), however this solution does not allow the programmer to account for quoted parameters which contain spaces.

The splitArgs function is added to String.prototype, meaning it can be treated as a function of string objects.

Original credit for the algorithm goes to Elgs Qian Chen.

Example Use

on('chat:message', function(msg) {
    var params = msg.content.splitArgs(),
        command = params.shift().substring(1);
    
    // msg.content === "!command with parameters, \"including 'with quotes'\""
    // params === ["with", "parameters,", "including 'with quotes'"]
    // command === "command"
});