Node: Not all globals are documented

Created on 20 May 2016  路  3Comments  路  Source: nodejs/node

  • Version: v4.3.1
  • Platform: Windows 64-bit
  • Subsystem: N/A

In the documentation of globals at https://nodejs.org/api/globals.html I'm missing certain globals, such as Uint16Array, Uint8Array, etc even though they are obviously globals and don't need to be required in.

For people trying to write universal javascript, it would be quite nice to have a proper documentation of all globals in node.

Running the following code will print out many globals that are missing in the global documentation page:

Object.getOwnPropertyNames(global).sort().forEach(x => console.log(x));
doc

Most helpful comment

I think documenting all of these would be out of scope for Node, but what would you think about e.g. linking to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects?

All 3 comments

I think documenting all of these would be out of scope for Node, but what would you think about e.g. linking to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects?

+1 to linking

Adding a note that node has many (other) global objects in common with modern browsers would be good to have (with the link that @addaleax suggested), rather than explicitly documenting each one, which is likely to change somewhat often.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

stevenvachon picture stevenvachon  路  3Comments

styfle picture styfle  路  3Comments

Brekmister picture Brekmister  路  3Comments

danielstaleiny picture danielstaleiny  路  3Comments

seishun picture seishun  路  3Comments