deno_doc 0.198.0

doc generation for deno
Documentation
# mod.ts
/**
 * Interface js doc
 */
export default interface Reader {
    /** Read n bytes */
    read?(buf: Uint8Array, something: unknown): Promise<number>
}
# output.txt
Defined in file:///mod.ts:3:1

interface default
  Interface js doc

  read?(buf: Uint8Array, something: unknown): Promise<number>
    Read n bytes


# output.json
{
  "symbols": [
    {
      "name": "default",
      "isDefault": true,
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 3,
            "col": 0,
            "byteIndex": 28
          },
          "declarationKind": "export",
          "jsDoc": {
            "doc": "Interface js doc"
          },
          "kind": "interface",
          "def": {
            "defName": "Reader",
            "methods": [
              {
                "name": "read",
                "jsDoc": {
                  "doc": "Read n bytes"
                },
                "kind": "method",
                "location": {
                  "filename": "file:///mod.ts",
                  "line": 5,
                  "col": 4,
                  "byteIndex": 90
                },
                "params": [
                  {
                    "kind": "identifier",
                    "name": "buf",
                    "optional": false,
                    "tsType": {
                      "repr": "Uint8Array",
                      "kind": "typeRef",
                      "value": {
                        "typeName": "Uint8Array"
                      }
                    }
                  },
                  {
                    "kind": "identifier",
                    "name": "something",
                    "optional": false,
                    "tsType": {
                      "repr": "unknown",
                      "kind": "keyword",
                      "value": "unknown"
                    }
                  }
                ],
                "optional": true,
                "returnType": {
                  "repr": "Promise",
                  "kind": "typeRef",
                  "value": {
                    "typeParams": [
                      {
                        "repr": "number",
                        "kind": "keyword",
                        "value": "number"
                      }
                    ],
                    "typeName": "Promise"
                  }
                }
              }
            ]
          }
        }
      ]
    }
  ]
}