CODEWITHSUNDEEP
javascriptjqueryobject
Timwi
Timwi

Reputation: 66573

How might one look at an object in JavaScript to find out what it is?

Note: I’m going to use a specific object as an example here, but please don’t post answers specific to this example; the question is more general.

Specific example

I wrote some jQuery code like this...

$('#some_button').click(function(event) {
    $.post('<some URL>', { <some parameters> },
        function() { <do something on success> })
        .error(function(x) {
            // What is x?
        });
    event.preventDefault();
});

Now, for the purpose of this question, let’s assume that there is no documentation about that object x that is passed in.

An obvious thing to do might be 

alert(x);

but all that will output is [object Object].

General question

What might be an easy way to find out what properties/methods an unknown object has? I’m thinking something that I’d just write during the debugging phase, no production code of course.

You may assume that jQuery is available.

Edit:

I’m fully aware of for (...), but surely that doesn’t mean there can’t be a better/easier way — I thought jQuery might have something built-in...

Upvotes: 5

Views: 1455

Answers (6)

Robert Koritnik
Robert Koritnik

Reputation: 105029

A general and single level basic javascript solution

Basic functionality looks like this:

var s = "";
for(var p in obj)
{
    s += p + " = " + obj[p] + "\n";
}
alert(s);

Object graph issue

It will enumerate over all properties of an object. If this particular object has deep object trees you should better put this into a function and then recall it on sub object. enumerate internal sub object using the same technique. Arrays are a similar issue.

But I suppose you'll be able to provide this kind of functionality from this starting example code.

Browser console solution

If you have development console open in your browser (in Firefox that would be Firebug) then you can easily just call this:

console.log(obj);

But there's a problem with IE, because when it comes to a complex object is just displays {...} which isn't really helpful. So this approach can only be used in Chrome and Firefox+Firebug.

A jQuery plugin for any browser

This is a small and simple plugin I've come up to enumerate an arbitrary object and display its content in browser's console:

$.extend({
    inspect: function(obj,n){
        n = n || "this";
        if ($.isArray(obj)) {
            for (var x = 0; x < obj.length; x++) {
                $.inspect(obj[x], n + "[" + x + "]");
            }
            return;
        }
        if ($.isPlainObject(‌​obj)) {
            for (var p in obj){
                $.inspect(obj[p], n + "." + p);
            }
            return;
        }
        console.log(n + " = " + obj.toString());
    }
});

This code works with any browser (I actually needed it for IE, because of the previously mentioned issue with {...} display.

It parses an object graph into console provided that your browser's console is open. In IE and Chrome that's the built in development console and in Firefox it's Firebug console.

You can use it as:

$.inspect(yourObject);

or

$.inspect(yourObject, "person");

The second optional parameter is used to give your object a name when displaying it. If you don't provide the name it will be set as "this". Your object will be displayed as:

this.name = "John"
this.lastname = "Doe"

Upvotes: 5

Marko
Marko

Reputation: 10992

console.log and typeof obj will suffice.

Upvotes: 0

RobG
RobG

Reputation: 147363

It is difficult in javascript to write a general function to determine whether an identifier references any particular type of value. Most such functions are limited to specific cases. A general "what is this" function is practically impossible if not limited to specific bounds.

If such a function was available, what would you do with it?

The general approach in javascript is to test for the properties or capabilities that are required for a particular purpose. What is the point in going further?

Upvotes: 1

John Duff
John Duff

Reputation: 38568

Your best bet would be to use a browser like Google Chrome or Firefox with the Firebug plugin then you can add a breakpoint and inspect the object. If it is just a simple Javascript object you could just loop through the properties like so:

for(name in object) { 
  alert("name: " + name + "value:" + object[name]);
}

Another option might be to serialize to JSON and output that. A solution for doing that can be found here.

Upvotes: 1

davin
davin

Reputation: 45525

console.log was built for that.

Alternatively (although I'm not sure what could be better than the first option) your own recursive implementation that loops through the objects properties with a simple for(parameter in obj){ ... }

Upvotes: 2

Mick Hansen
Mick Hansen

Reputation: 2694

console.log

will usually give you a better idea of the properties an object has.

Upvotes: 1

Related Questions