-
Notifications
You must be signed in to change notification settings - Fork 8
/
example.json
44 lines (44 loc) · 11.4 KB
/
example.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
"title": "About this Documentation Node.js v0.10.31 Manual & Documentation",
"lang": "en",
"canonicalLink": "http://nodejs.org/api/documentation.html",
"tags": [],
"image": null,
"videos": [],
"text": "The goal of this documentation is to comprehensively explain the Node.js API, both from a reference as well as a conceptual point of view. Each section describes a built-in module or high-level concept.\n\nWhere appropriate, property types, method arguments, and the arguments provided to event handlers are detailed in a list underneath the topic heading.\n\nEvery .html document has a corresponding .json document presenting the same information in a structured manner. This feature is experimental, and added for the benefit of IDEs and other utilities that wish to do programmatic things with the documentation.\n\nEvery .html and .json file is generated based on the corresponding\n\n.markdown file in the doc/api/ folder in node's source tree. The documentation is generated using the tools/doc/generate.js program. The HTML template is located at doc/template.html.\n\nThroughout the documentation, you will see indications of a section's stability. The Node.js API is still somewhat changing, and as it matures, certain parts are more reliable than others. Some are so proven, and so relied upon, that they are unlikely to ever change at all. Others are brand new and experimental, or known to be hazardous and in the process of being redesigned.\n\nThe stability indices are as follows:\n\nStability: 0 - Deprecated\n\nThis feature is known to be problematic, and changes are\n\nplanned. Do not rely on it. Use of the feature may cause warnings. Backwards\n\ncompatibility should not be expected.Stability: 1 - Experimental\n\nThis feature was introduced recently, and may change\n\nor be removed in future versions. Please try it out and provide feedback.\n\nIf it addresses a use-case that is important to you, tell the node core team.Stability: 2 - Unstable\n\nThe API is in the process of settling, but has not yet had\n\nsufficient real-world testing to be considered stable. Backwards-compatibility\n\nwill be maintained if reasonable.Stability: 3 - Stable\n\nThe API has proven satisfactory, but cleanup in the underlying\n\ncode may cause minor changes. Backwards-compatibility is guaranteed.Stability: 4 - API Frozen\n\nThis API has been tested extensively in production and is\n\nunlikely to ever have to change.Stability: 5 - Locked\n\nUnless serious bugs are found, this code will not ever\n\nchange. Please do not suggest changes in this area; they will be refused.\n\nStability: 1 - Experimental\n\nEvery HTML file in the markdown has a corresponding JSON file with the same data.\n\nThis feature is new as of node v0.6.12. It is experimental.",
"raw": "<!doctype html>\n<html lang=\"en\">\n<head>\n <meta charset=\"utf-8\">\n <title>About this Documentation Node.js v0.10.31 Manual & Documentation</title>\n <link rel=\"stylesheet\" href=\"assets/style.css\">\n <link rel=\"stylesheet\" href=\"assets/sh.css\">\n <link rel=\"canonical\" href=\"http://nodejs.org/api/documentation.html\">\n</head>\n<body class=\"alt apidoc\" id=\"api-section-documentation\">\n <div id=\"intro\" class=\"interior\">\n <a href=\"/\" title=\"Go back to the home page\">\n <img id=\"logo\" src=\"http://nodejs.org/images/logo-light.png\" alt=\"node.js\">\n </a>\n </div>\n <div id=\"content\" class=\"clearfix\">\n <div id=\"column2\" class=\"interior\">\n <ul>\n <li><a href=\"/\" class=\"home\">Home</a></li>\n <li><a href=\"/download/\" class=\"download\">Download</a></li>\n <li><a href=\"/about/\" class=\"about\">About</a></li>\n <li><a href=\"http://npmjs.org/\" class=\"npm\">npm Registry</a></li>\n <li><a href=\"http://nodejs.org/api/\" class=\"docs current\">Docs</a></li>\n <li><a href=\"http://blog.nodejs.org\" class=\"blog\">Blog</a></li>\n <li><a href=\"/community/\" class=\"community\">Community</a></li>\n <li><a href=\"/logos/\" class=\"logos\">Logos</a></li>\n <li><a href=\"http://jobs.nodejs.org/\" class=\"jobs\">Jobs</a></li>\n </ul>\n <p class=\"twitter\"><a href=\"http://twitter.com/nodejs\">@nodejs</a></p>\n </div>\n\n <div id=\"column1\" class=\"interior\">\n <header>\n <h1>Node.js v0.10.31 Manual & Documentation</h1>\n <div id=\"gtoc\">\n <p>\n <a href=\"index.html\" name=\"toc\">Index</a> |\n <a href=\"all.html\">View on single page</a> |\n <a href=\"documentation.json\">View as JSON</a>\n </p>\n </div>\n <hr>\n </header>\n\n <div id=\"toc\">\n <h2>Table of Contents</h2>\n <ul>\n<li><a href=\"#documentation_about_this_documentation\">About this Documentation</a><ul>\n<li><a href=\"#documentation_stability_index\">Stability Index</a></li>\n<li><a href=\"#documentation_json_output\">JSON Output</a></li>\n</ul>\n</li>\n</ul>\n\n </div>\n\n <div id=\"apicontent\">\n <h1>About this Documentation<span><a class=\"mark\" href=\"#documentation_about_this_documentation\" id=\"documentation_about_this_documentation\">#</a></span></h1>\n<!-- type=misc -->\n\n<p>The goal of this documentation is to comprehensively explain the Node.js\nAPI, both from a reference as well as a conceptual point of view. Each\nsection describes a built-in module or high-level concept.\n\n</p>\n<p>Where appropriate, property types, method arguments, and the arguments\nprovided to event handlers are detailed in a list underneath the topic\nheading.\n\n</p>\n<p>Every <code>.html</code> document has a corresponding <code>.json</code> document presenting\nthe same information in a structured manner. This feature is\nexperimental, and added for the benefit of IDEs and other utilities that\nwish to do programmatic things with the documentation.\n\n</p>\n<p>Every <code>.html</code> and <code>.json</code> file is generated based on the corresponding\n<code>.markdown</code> file in the <code>doc/api/</code> folder in node's source tree. The\ndocumentation is generated using the <code>tools/doc/generate.js</code> program.\nThe HTML template is located at <code>doc/template.html</code>.\n\n</p>\n<h2>Stability Index<span><a class=\"mark\" href=\"#documentation_stability_index\" id=\"documentation_stability_index\">#</a></span></h2>\n<!--type=misc-->\n\n<p>Throughout the documentation, you will see indications of a section's\nstability. The Node.js API is still somewhat changing, and as it\nmatures, certain parts are more reliable than others. Some are so\nproven, and so relied upon, that they are unlikely to ever change at\nall. Others are brand new and experimental, or known to be hazardous\nand in the process of being redesigned.\n\n</p>\n<p>The stability indices are as follows:\n\n</p>\n<pre class=\"api_stability_0\">Stability: 0 - Deprecated\nThis feature is known to be problematic, and changes are\nplanned. Do not rely on it. Use of the feature may cause warnings. Backwards\ncompatibility should not be expected.</pre><pre class=\"api_stability_1\">Stability: 1 - Experimental\nThis feature was introduced recently, and may change\nor be removed in future versions. Please try it out and provide feedback.\nIf it addresses a use-case that is important to you, tell the node core team.</pre><pre class=\"api_stability_2\">Stability: 2 - Unstable\nThe API is in the process of settling, but has not yet had\nsufficient real-world testing to be considered stable. Backwards-compatibility\nwill be maintained if reasonable.</pre><pre class=\"api_stability_3\">Stability: 3 - Stable\nThe API has proven satisfactory, but cleanup in the underlying\ncode may cause minor changes. Backwards-compatibility is guaranteed.</pre><pre class=\"api_stability_4\">Stability: 4 - API Frozen\nThis API has been tested extensively in production and is\nunlikely to ever have to change.</pre><pre class=\"api_stability_5\">Stability: 5 - Locked\nUnless serious bugs are found, this code will not ever\nchange. Please do not suggest changes in this area; they will be refused.</pre><h2>JSON Output<span><a class=\"mark\" href=\"#documentation_json_output\" id=\"documentation_json_output\">#</a></span></h2>\n<pre class=\"api_stability_1\">Stability: 1 - Experimental</pre><p>Every HTML file in the markdown has a corresponding JSON file with the\nsame data.\n\n</p>\n<p>This feature is new as of node v0.6.12. It is experimental.\n</p>\n\n </div>\n </div>\n </div>\n <div id=\"footer\">\n <a href=\"http://joyent.com\" class=\"joyent-logo\">Joyent</a>\n <ul class=\"clearfix\">\n <li><a href=\"/\">Node.js</a></li>\n <li><a href=\"/download/\">Download</a></li>\n <li><a href=\"/about/\">About</a></li>\n <li><a href=\"http://npmjs.org/\">npm Registry</a></li>\n <li><a href=\"http://nodejs.org/api/\">Docs</a></li>\n <li><a href=\"http://blog.nodejs.org\">Blog</a></li>\n <li><a href=\"/community/\">Community</a></li>\n <li><a href=\"/logos/\">Logos</a></li>\n <li><a href=\"http://jobs.nodejs.org/\">Jobs</a></li>\n <li><a href=\"http://twitter.com/nodejs\" class=\"twitter\">@nodejs</a></li>\n </ul>\n\n <p>Copyright <a href=\"http://joyent.com/\">Joyent, Inc</a>, Node.js is a <a href=\"/trademark-policy.pdf\">trademark</a> of Joyent, Inc. View <a href=\"https://raw.github.com/joyent/node/v0.10.31/LICENSE\">license</a>.</p>\n </div>\n\n <script src=\"../sh_main.js\"></script>\n <script src=\"../sh_javascript.min.js\"></script>\n <script>highlight(undefined, undefined, 'pre');</script>\n <script>\n window._gaq = [['_setAccount', 'UA-10874194-2'], ['_trackPageview']];\n (function(d, t) {\n var g = d.createElement(t),\n s = d.getElementsByTagName(t)[0];\n g.src = '//www.google-analytics.com/ga.js';\n s.parentNode.insertBefore(g, s);\n }(document, 'script'));\n </script>\n</body>\n</html>\n\n",
"stats": {
"ok": true,
"sentiment": 0.018134715025906734,
"title": "About this Documentation Node.js v0.10.31 Manual & Documentation",
"topics": [
"Stability",
"change",
"API",
"feature",
"documentation",
"node",
"html",
"Node",
"code",
"Backwards-compatibility",
"Experimental",
"cause",
"proces",
"stability",
"template",
"HTML",
"markdown",
"json",
"argument",
"section",
"js api",
"Documentation"
],
"words": 414,
"difficulty": 0.6416666666666667,
"minutes": 4,
"image": null
},
"summary": "About this Documentation Node.js v0.10.31 Manual & Documentation\n Each section describes a built-in module or high-level concept.\n This feature is experimental, and added for the benefit of IDEs and other utilities that wish to do programmatic things with the documentation.\n The documentation is generated using the tools/doc/generate.js program. \n The Node.js API is still somewhat changing, and as it matures, certain parts are more reliable than others. \n Use of the feature may cause warnings. \n Please try it out and provide feedback.\n Please do not suggest changes in this area; they will be refused.\n It is experimental."
}