17

I am currently building an API for JavaScript, predominantly using Visual Studio 2010 and JetBrains WebStorm (brilliant if you're looking for a bulletproof JavaScript IDE).

Whilst looking through the intellisense list in Visual Studio (trying to familiarize myself with the JavaScript API), I noticed that both Document and document exist.

  1. What is the difference between Document and document?
  2. What is document an instance of (if any) ?
  3. How does one use Document (as it is not a function, therefore, not constructable)?
  4. Most importantly, What is the harm in "monkey-patching" Document to make it constructable?

The rationale behind these questions is that I want to create some objects that fit into my API (for example; Document, HTMLElement etc.), but as these appear to already exist in some respect, I'm not confident that I should be overwriting their native implementation.

Charles
  • 50,943
  • 13
  • 104
  • 142
Matthew Layton
  • 39,871
  • 52
  • 185
  • 313
  • MDN has created more confusion between "Document" vs "document" https://developer.mozilla.org/en-US/docs/Web/API/Document/getElementsByClassName – vikramvi Aug 25 '22 at 10:35
  • But W3School has used `document` all the places. https://www.w3schools.com/jsref/dom_obj_document.asp – vikramvi Aug 25 '22 at 10:35

2 Answers2

18

What is the difference between Document and document?

document (or window.document) is a reference to the document contained in the window. (spec)

Document is the DOM interface for documents, which is exposed on the global object. (spec, spec)

How does one use Document (as it is not a function, therefore, not constructable)?

It's a host object and does not need to follow the EcmaScript spec - yet that does not mean it's not a function. It may differ from browser to browser as well. Yet it is not intended to be called (if you try it you'll get a NOT_SUPPORTED_ERR), there are other methods to instantiate/obtain new documents. What you can still use it for is

> document instanceof Document
true
> Document.prototype
DocumentPrototype {
    adoptNode: Function
    constructor: Document
    createAttribute: Function
    …
    querySelector: Function
    querySelectorAll: Function
}
|- NodePrototype
|- Object

so you could extend its prototype and use those methods on all XMLDocuments/HTMLDocuments in your app (but only if you know what’s wrong with extending the DOM).

Most importantly, what is the harm in "monkey-patching" Document to make it constructable?

I'm not sure how you would do that. Overwriting it could harm every script that expects it to work as above (unless you fix the prototype property of your new function). And maybe the Document property of window is non-writable in some environments, so you could harm yourself.

Bergi
  • 630,263
  • 148
  • 957
  • 1,375
  • 1
    So basically `Document.prototype` is *essentially* similar to `window.document`/`document`? – ZomoXYZ Apr 07 '16 at 15:53
  • 1
    @Jaketr00: Similar? Sure. In fact, `Document.prototype.isPrototypeOf(window.document)` is `true` :-) – Bergi Apr 07 '16 at 16:11
0
  1. Document is the prototype definition for the document object of the global scope witch means that the Document's prototype is share with his instance (document). like Window is the prototype definition for the window object.
  2. The Document is native prototype object and you can't create instances of it, only one instance is created when the page is created (again, like the window) just like a single tone object.
  3. I don't think that to override the Document will be a good practice.

My suggestion is to use a namespace for your API and create your Document and HTMLElement etc inside your api namespace, for example:

var api = {
    Document: { /* your implementation */ },
    HTMLElement: { /* your implementation */ }
    //...
};

var myDocument = new api.Document();

More then that, you can inherit the real Document prototype and use it in your own object like so:

api.Document = function(){ /* your implementation */ }
api.Document.prototype = Document.prototype;

var myDocument = new api.Document();

Hope this is help and I understood you question...

udidu
  • 8,269
  • 6
  • 48
  • 68