Apply your JS skills to key Mozilla projects as an MDN Fellow! http://mzl.la/MDNFellowship

mozilla

Revision 81301 of Object.prototype.toSource()

  • Revision slug: JavaScript/Reference/Global_Objects/Object/toSource
  • Revision title: toSource
  • Revision id: 81301
  • Created:
  • Creator: evilpie
  • Is current revision? No
  • Comment 3 words added, 1 words removed

Revision Content

{{ Non-standard_header() }}

Summary

Returns a string representing the source code of the object.

Method of Object
Implemented in JavaScript 1.3
ECMAScript Edition none

Syntax

obj.toSource()

Parameters

None.

Description

The toSource method returns the following values:

  • For the built-in Object object, toSource returns the following string indicating that the source code is not available:
function Object() {
   [native code]
}
  • For instances of Object, toSource returns a string representing the source code.

You can call toSource while debugging to examine the contents of an object.

It is safe for objects to override the toSource method.  For example:

function Person(name) {
    this.name = name;
}
Person.prototype.toSource = function Person_toSource() {
    return "new Person(" + uneval(this.name) + ")";
};
alert(new Person("Joe").toSource());    // ---> new Person("Joe")

Built-in toSource methods

Each core JavaScript type has its own toSource method. These objects are: {{ :en/ToSource() }}

Examples

Example: Using toSource

The following code defines the Dog object type and creates theDog, an object of type Dog:

function Dog(name, breed, color, sex) {
   this.name=name;
   this.breed=breed;
   this.color=color;
   this.sex=sex;
}

theDog = new Dog("Gabby", "Lab", "chocolate", "girl");

Calling the toSource method of theDog displays the JavaScript source that defines the object:

theDog.toSource();

returns

({name:"Gabby", breed:"Lab", color:"chocolate", sex:"girl"})

See Also

toString

{{ languages( { "fr": "fr/R\u00e9f\u00e9rence_de_JavaScript_1.5_Core/Objets_globaux/Object/toSource", "ja": "ja/Core_JavaScript_1.5_Reference/Global_Objects/Object/toSource", "pl": "pl/Dokumentacja_j\u0119zyka_JavaScript_1.5/Obiekty/Object/toSource" } ) }}

Revision Source

<p>{{ Non-standard_header() }}</p>
<h3 name="Summary">Summary</h3>
<p>Returns a string representing the source code of the object.</p>
<table class="standard-table"> <thead> <tr> <th class="header" colspan="2">Method of <a href="/en/JavaScript/Reference/Global_Objects/Object"><code>Object</code></a></th> </tr> </thead> <tbody> <tr> <td>Implemented in</td> <td>JavaScript 1.3</td> </tr> <tr> <td>ECMAScript Edition</td> <td>none</td> </tr> </tbody>
</table> <h3 name="Syntax">Syntax</h3>
<p><code><em>obj</em>.toSource()</code></p>
<h3 name="Parameters">Parameters</h3>
<p>None.</p>
<h3 name="Description">Description</h3>
<p>The <code>toSource</code> method returns the following values:</p>
<ul> <li>For the built-in <code>Object</code> object, <code>toSource</code> returns the following string indicating that the source code is not available:</li>
</ul>
<pre class="eval">function Object() {
   [native code]
}
</pre>
<ul> <li>For instances of <code>Object</code>, <code>toSource</code> returns a string representing the source code.</li>
</ul>
<p>You can call <code>toSource</code> while debugging to examine the contents of an object.</p>
<p>It is safe for objects to override the <code>toSource</code> method.  For example:</p>
<pre>function Person(name) {
    this.name = name;
}
Person.prototype.toSource = function Person_toSource() {
    return "new Person(" + uneval(this.name) + ")";
};
alert(new Person("Joe").toSource());    // ---&gt; new Person("Joe")
</pre>
<h4 name="Built-in_toString_methods">Built-in <code>toSource</code> methods</h4>
<p>Each core JavaScript type has its own <code>toSource</code> method. These objects are: {{ :en/ToSource() }}</p>
<h3 name="Examples">Examples</h3>
<h4 name="Example:_Using_toSource">Example: Using <code>toSource</code></h4>
<p>The following code defines the <code>Dog</code> object type and creates <code>theDog</code>, an object of type <code>Dog</code>:</p>
<pre class="eval">function Dog(name, breed, color, sex) {
   this.name=name;
   this.breed=breed;
   this.color=color;
   this.sex=sex;
}

theDog = new Dog("Gabby", "Lab", "chocolate", "girl");
</pre>
<p>Calling the <code>toSource</code> method of <code>theDog</code> displays the JavaScript source that defines the object:</p>
<pre class="eval">theDog.toSource();
</pre>
<p>returns</p>
<pre class="eval">({name:"Gabby", breed:"Lab", color:"chocolate", sex:"girl"})
</pre>
<h3 name="See_Also">See Also</h3>
<p><a href="/en/JavaScript/Reference/Global_Objects/Object/toString" title="en/JavaScript/Reference/Global_Objects/Object/toString">toString</a></p>
<div class="noinclude">
<p>{{ languages( { "fr": "fr/R\u00e9f\u00e9rence_de_JavaScript_1.5_Core/Objets_globaux/Object/toSource", "ja": "ja/Core_JavaScript_1.5_Reference/Global_Objects/Object/toSource", "pl": "pl/Dokumentacja_j\u0119zyka_JavaScript_1.5/Obiekty/Object/toSource" } ) }}</p>
</div>
Revert to this revision