JavaScript Debugging Tip: Objects

By  on  

Every so often I want to view what an object looks like at various points of an execution cycle.  Many people like to use breakpoint debugging but I find it a bit annoying and tedious -- it's simply not for me.  The problem comes when I log an object to the console; since other operations may have occurred between my log call and the rest of execution, I may not be seeing a true representation of the object at that moment within the console.  There are a few solutions you can employ:

The first solution is converting the object to a JSON string to browse its contents:

// Log the JSON representation of this object 
// at *this* moment
console.log(JSON.stringify(myObject));

Now I can see every key and value of the object without needing to click around it.  If you prefer to work with a real object in the debugger, simply convert the JSON object from string to an object again, effectively cloning it:

// Object -> String -> Object (clone)
console.log(JSON.parse(JSON.stringify(myObject)));

Of coures this isn't a perfect solution for some people but it has worked beautifully for me in the past.  Maybe I'm a lesser programmer for not liking breakpoint debugging but hey -- I tend to get things done!

Recent Features

  • By
    JavaScript Promise API

    While synchronous code is easier to follow and debug, async is generally better for performance and flexibility. Why "hold up the show" when you can trigger numerous requests at once and then handle them when each is ready?  Promises are becoming a big part of the JavaScript world...

  • By
    An Interview with Eric Meyer

    Your early CSS books were instrumental in pushing my love for front end technologies. What was it about CSS that you fell in love with and drove you to write about it? At first blush, it was the simplicity of it as compared to the table-and-spacer...

Incredible Demos

  • By
    jQuery UI DatePicker:  Disable Specified Days

    One project I'm currently working on requires jQuery. The project also features a datepicker for requesting a visit to their location. jQuery UI's DatePicker plugin was the natural choice and it does a really nice job. One challenge I encountered was the...

  • By
    MooTools Zoomer Plugin

    I love to look around the MooTools Forge. As someone that creates lots of plugins, I get a lot of joy out of seeing what other developers are creating and possibly even how I could improve them. One great plugin I've found is...

Discussion

  1. MaxArt

    Chrome has a mixed behavior: it displays the first 5 properties of the object at runtime, but when you expand it it shows the property values at interaction time. So it’s not necessary for simple objects.

    Note: the trick does *not* work in Internet Explorer. It would just log [object Object] in the console.
    Why am I not surprised?

  2. Cristian

    If you would get a better readibility using JSON.stringify, use something like that:

    JSON.stringify(myObject, null, '  ')

    The last parameter is the caracter/s to indent the stringified object.

  3. @MaxArt, try console.dir instead of console.log for Internet Explorer.

    • @Jack Moore – did not know that. Very useful! Thanks!

    • @Jack Moore – Very useful Jack!

    • Thats something new and very useful :) thanks Jack.

  4. deemyBoy

    @OP (David Walsh)

    I don’t get this –> Now I can see every key and value of the object without needing to click around it. If you prefer to work with a real object in the debugger, simply convert the JSON object from string to an object again, effectively cloning it:

    If you already have a JSON object then why you need to clone it?

    Raises lots of questions in my noobie mind!!!

    Primary level (or direct) questions:
    ————————————
    If you clone it do you now have 2 copies?
    How do you rename the 2nd copy?
    Where is the 2nd copy stored?
    How do you access it?

    Secondary questions:
    ——————–
    Does this make maintenance a headache?
    Can any (desired) modifications/updates be overwritten so rendering cloning pointless?
    How do specify which you are using (original or clone)?

    Why do people just throw stuff out there such as “effectively cloning it” without either explaining the implications themselves or linking to articles or sites that explain it!?

    Is cloning god/bad?
    Is it best practise?
    Cloning explained –>

    Etc., etc.

    Used it btw and could finally “see” my object instead of “[Object, Object, Object, Object, Object]” so guess I owe you a big thanks for this on the most part.

    If you could add further clarification about cloning that would be good.

    In my mind if have an object and realise I don’t want to JSON.stringify it anymore the rather than doing:

    console.log(JSON.parse(JSON.stringify(myObject)));
    

    I just do:

    console.log(myObject);
    

    Does that make sense?
    In essence, I already have my object so why stringify and parse it to get back to where I was in the first place???????
    ??????
    ??????

  5. console.log("%j", myObject); or console.dir(myObject)

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