Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not all globals are documented #6894

Closed
dfahlander opened this issue May 20, 2016 · 3 comments
Closed

Not all globals are documented #6894

dfahlander opened this issue May 20, 2016 · 3 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@dfahlander
Copy link

dfahlander commented May 20, 2016

  • 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));
@addaleax
Copy link
Member

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?

@jasnell
Copy link
Member

jasnell commented May 20, 2016

+1 to linking

@mscdex
Copy link
Contributor

mscdex commented May 20, 2016

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.

addaleax added a commit to addaleax/node that referenced this issue May 20, 2016
Fishrock123 pushed a commit to Fishrock123/node that referenced this issue May 30, 2016
Fixes: nodejs#6894
PR-URL: nodejs#6900
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
rvagg pushed a commit that referenced this issue Jun 2, 2016
Fixes: #6894
PR-URL: #6900
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
MylesBorins pushed a commit that referenced this issue Jun 3, 2016
Fixes: #6894
PR-URL: #6900
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
MylesBorins pushed a commit that referenced this issue Jun 24, 2016
Fixes: #6894
PR-URL: #6900
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
MylesBorins pushed a commit that referenced this issue Jun 24, 2016
Fixes: #6894
PR-URL: #6900
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
@sam-github sam-github added doc Issues and PRs related to the documentations. and removed doc Issues and PRs related to the documentations. labels Dec 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

5 participants