Detect Function Argument Names with JavaScript

By  on  

I was recently looking over the promisify-node code to see how the author was able to convert basic functions and objects to a promised-based API.  I quickly realized that they were reading function signatures to look for common callback argument names like callback and cb.  The strategy seemed odd but probably necessary.

I took a few minutes to pick out the JavaScript function which parsed argument names for a function and here it is:

function getArgs(func) {
  // First match everything inside the function argument parens.
  var args = func.toString().match(/function\s.*?\(([^)]*)\)/)[1];
 
  // Split the arguments string into an array comma delimited.
  return args.split(',').map(function(arg) {
    // Ensure no inline comments are parsed and trim the whitespace.
    return arg.replace(/\/\*.*\*\//, '').trim();
  }).filter(function(arg) {
    // Ensure no undefined values are added.
    return arg;
  });
}

So given the function above and a sample function, here's how it would work:

function myCustomFn(arg1, arg2,arg3) {
  
}

console.log(getArgs(myCustomFn)); // ["arg1", "arg2", "arg3"]

Aren't regular expressions a beautiful thing?  I can't name many uses for such a function but here it is if you're looking to do such a thing!

Recent Features

  • By
    Create a CSS Cube

    CSS cubes really showcase what CSS has become over the years, evolving from simple color and dimension directives to a language capable of creating deep, creative visuals.  Add animation and you've got something really neat.  Unfortunately each CSS cube tutorial I've read is a bit...

  • By
    Responsive Images: The Ultimate Guide

    Chances are that any Web designers using our Ghostlab browser testing app, which allows seamless testing across all devices simultaneously, will have worked with responsive design in some shape or form. And as today's websites and devices become ever more varied, a plethora of responsive images...

Incredible Demos

  • By
    MooTools PulseFade Plugin

    I was recently driven to create a MooTools plugin that would take an element and fade it to a min from a max for a given number of times. Here's the result of my Moo-foolery. The MooTools JavaScript Options of the class include: min: (defaults to .5) the...

  • By
    LightFace:  Facebook Lightbox for MooTools

    One of the web components I've always loved has been Facebook's modal dialog.  This "lightbox" isn't like others:  no dark overlay, no obnoxious animating to size, and it doesn't try to do "too much."  With Facebook's dialog in mind, I've created LightFace:  a Facebook lightbox...

Discussion

  1. MaxArt

    Well, good luck using that regex with ES6 arrow functions :I
    And it can be also tried by comments put among the function’s arguments.

    Man, parsing is _hard_…

  2. Fred

    I guess that’s how Angular injects objects like $scope, $http and so on…

  3. I guess, this will work till the first object destructing in arguments. E.g. in FF:

    function a({test: test}) {}
    a.toString().match(/function\s.*?\(([^)]*)\)/)[1].split(",").map(function(arg) {
        // Ensure no inline comments are parsed and trim the whitespace.
        return arg.replace(/\/\*.*\*\//, "").trim();
      }).filter(function(arg) {
        // Ensure no undefineds are added.
        return arg;
      });
    

    For promisify-node purposes this should be sufficient though.

  4. mihailik

    Chrome and FireFox already have arrow functions in mainstream release builds, so as MaxArt mentioned this fails:

    getArgs((a,b,c) => a+b)
    
    :TypeError: func.toString(...).match(...) is null
    
  5. Is this fast enough for production?

    • Define fast enough.

    • Not that it answers your question, but this approach is the one Angular takes with its dependency injection. Back when I was getting into Angular, I created a simple example of this approach. However these days I’d favour destructuring every time, as Deku does.

  6. Jos de Jong

    Please put a big, big warning in this post that you be careful with relying on argument names: when you minify code, argument names are typically mangled. So if you rely matching arguments by their name like arg1, $scope, or $http, you code will break when minifying it. The Angular folks among us know about the troubles this can give…

  7. stoeffel

    I created a module for this a while ago. https://github.com/stoeffel/retrieve-arguments

  8. Yeah, as Jos de Jong mentioned, don’t do this; it breaks when you minify (Which I hope you’re doing). The way Angular works is that it will look for these but it will first look for an array around the function call to resolve its dependencies and it will also look for an array of arguments keyed $inject on the function to invoke.

    While it is a neat little party trick, ultimately its not all that great.

  9. Allain

    https://www.npmjs.com/package/get-parameter-names has this broken out as an noon package.

  10. sminutoli

    Hi Dave, I’m wondering about es2015 args with default values, destructuring and so on… how do you handle it?

    • This package uses recast in order to create an AST and then the parameter names are gathered from their, this allows it to support pattern matching, default arguments, arrow functions and other ES6 features.

      https://www.npmjs.com/package/es-arguments

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!