mirror of
https://github.com/documentationjs/documentation.git
synced 2026-02-01 14:53:07 +00:00
4c66fb14c7
Adds a new option, `--no-markdown-toc`, to turn off Table of Contents generation. Table of contents are now generated by default with markdown output, including through the `readme` command. Fixes https://github.com/documentationjs/documentation/issues/220
558 lines
17 KiB
JSON
558 lines
17 KiB
JSON
{
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "html",
|
|
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
|
|
},
|
|
{
|
|
"depth": 3,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Table of Contents"
|
|
}
|
|
],
|
|
"data": {
|
|
"id": "table-of-contents",
|
|
"htmlAttributes": {
|
|
"id": "table-of-contents"
|
|
},
|
|
"hProperties": {
|
|
"id": "table-of-contents"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "list",
|
|
"ordered": false,
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"loose": false,
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "link",
|
|
"title": null,
|
|
"url": "#sessionscreate",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "sessions.create"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 2,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "sessions.create"
|
|
}
|
|
],
|
|
"data": {
|
|
"id": "sessionscreate",
|
|
"htmlAttributes": {
|
|
"id": "sessionscreate"
|
|
},
|
|
"hProperties": {
|
|
"id": "sessionscreate"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Attempt to establish a cookie-based session in exchange for credentials.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 73,
|
|
"offset": 72
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 73,
|
|
"offset": 72
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "credentials"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "object"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "credentials.name"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Login username. Also accepted as ",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 34,
|
|
"offset": 33
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "username",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 34,
|
|
"offset": 33
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 44,
|
|
"offset": 43
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " or ",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 44,
|
|
"offset": 43
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 48,
|
|
"offset": 47
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "email",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 48,
|
|
"offset": 47
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 55,
|
|
"offset": 54
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": ".",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 55,
|
|
"offset": 54
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 56,
|
|
"offset": 55
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 56,
|
|
"offset": 55
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "credentials.password"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Login password",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15,
|
|
"offset": 14
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15,
|
|
"offset": 14
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "callback"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "?"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Gets passed ",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 13,
|
|
"offset": 12
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "(err, { success:Boolean })",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 13,
|
|
"offset": 12
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 41,
|
|
"offset": 40
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": ".",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 41,
|
|
"offset": 40
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 42,
|
|
"offset": 41
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 42,
|
|
"offset": 41
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Returns "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Promise"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "promise, to be resolved on success or rejected on failure",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 58,
|
|
"offset": 57
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 58,
|
|
"offset": 57
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
} |