documentation/test/fixture/nearby_params.output.md.json

{
  "type": "root",
  "children": [
    {
      "depth": 1,
      "type": "heading",
      "children": [
        {
          "type": "text",
          "value": "sessions.create"
        }
      ]
    },
    {
      "type": "paragraph",
      "children": [
        {
          "type": "text",
          "value": "Attempt to establish a cookie-based session in exchange for credentials.",
          "position": {
            "start": {
              "line": 1,
              "column": 1
            },
            "end": {
              "line": 1,
              "column": 73
            },
            "indent": []
          }
        }
      ],
      "position": {
        "start": {
          "line": 1,
          "column": 1
        },
        "end": {
          "line": 1,
          "column": 73
        },
        "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",
                      "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",
                              "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
                                },
                                "end": {
                                  "line": 1,
                                  "column": 34
                                },
                                "indent": []
                              }
                            },
                            {
                              "type": "inlineCode",
                              "value": "username",
                              "position": {
                                "start": {
                                  "line": 1,
                                  "column": 34
                                },
                                "end": {
                                  "line": 1,
                                  "column": 44
                                },
                                "indent": []
                              }
                            },
                            {
                              "type": "text",
                              "value": " or ",
                              "position": {
                                "start": {
                                  "line": 1,
                                  "column": 44
                                },
                                "end": {
                                  "line": 1,
                                  "column": 48
                                },
                                "indent": []
                              }
                            },
                            {
                              "type": "inlineCode",
                              "value": "email",
                              "position": {
                                "start": {
                                  "line": 1,
                                  "column": 48
                                },
                                "end": {
                                  "line": 1,
                                  "column": 55
                                },
                                "indent": []
                              }
                            },
                            {
                              "type": "text",
                              "value": ".",
                              "position": {
                                "start": {
                                  "line": 1,
                                  "column": 55
                                },
                                "end": {
                                  "line": 1,
                                  "column": 56
                                },
                                "indent": []
                              }
                            }
                          ],
                          "position": {
                            "start": {
                              "line": 1,
                              "column": 1
                            },
                            "end": {
                              "line": 1,
                              "column": 56
                            },
                            "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",
                              "type": "link",
                              "children": [
                                {
                                  "type": "text",
                                  "value": "string"
                                }
                              ]
                            }
                          ]
                        },
                        {
                          "type": "text",
                          "value": " "
                        },
                        {
                          "type": "paragraph",
                          "children": [
                            {
                              "type": "text",
                              "value": "Login password",
                              "position": {
                                "start": {
                                  "line": 1,
                                  "column": 1
                                },
                                "end": {
                                  "line": 1,
                                  "column": 15
                                },
                                "indent": []
                              }
                            }
                          ],
                          "position": {
                            "start": {
                              "line": 1,
                              "column": 1
                            },
                            "end": {
                              "line": 1,
                              "column": 15
                            },
                            "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",
                      "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
                        },
                        "end": {
                          "line": 1,
                          "column": 13
                        },
                        "indent": []
                      }
                    },
                    {
                      "type": "inlineCode",
                      "value": "(err, { success:Boolean })",
                      "position": {
                        "start": {
                          "line": 1,
                          "column": 13
                        },
                        "end": {
                          "line": 1,
                          "column": 41
                        },
                        "indent": []
                      }
                    },
                    {
                      "type": "text",
                      "value": ".",
                      "position": {
                        "start": {
                          "line": 1,
                          "column": 41
                        },
                        "end": {
                          "line": 1,
                          "column": 42
                        },
                        "indent": []
                      }
                    }
                  ],
                  "position": {
                    "start": {
                      "line": 1,
                      "column": 1
                    },
                    "end": {
                      "line": 1,
                      "column": 42
                    },
                    "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",
              "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
                },
                "end": {
                  "line": 1,
                  "column": 58
                },
                "indent": []
              }
            }
          ],
          "position": {
            "start": {
              "line": 1,
              "column": 1
            },
            "end": {
              "line": 1,
              "column": 58
            },
            "indent": []
          }
        }
      ]
    }
  ]
}