deno_doc 0.204.0

doc generation for deno
Documentation 
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# mod.ts
export interface Thing {
  get size(): number;
  set size(value: number | string);
}

# diagnostics
error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> /mod.ts:1:18
  | 
1 | export interface Thing {
  |                  ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> /mod.ts:2:7
  | 
2 |   get size(): number;
  |       ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> /mod.ts:3:7
  | 
3 |   set size(value: number | string);
  |       ^


error[missing-return-type]: exported function is missing an explicit return type annotation
 --> /mod.ts:3:7
  | 
3 |   set size(value: number | string);
  |       ^

# output.txt
Defined in file:///mod.ts:0:1

interface Thing

  get size(): number
  set size(value: number | string)


# output.json
{
  "symbols": [
    {
      "name": "Thing",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 0,
            "col": 0,
            "byteIndex": 0
          },
          "declarationKind": "export",
          "kind": "interface",
          "def": {
            "methods": [
              {
                "name": "size",
                "kind": "getter",
                "location": {
                  "filename": "file:///mod.ts",
                  "line": 1,
                  "col": 2,
                  "byteIndex": 27
                },
                "params": [],
                "returnType": {
                  "repr": "number",
                  "kind": "keyword",
                  "value": "number"
                }
              },
              {
                "name": "size",
                "kind": "setter",
                "location": {
                  "filename": "file:///mod.ts",
                  "line": 2,
                  "col": 2,
                  "byteIndex": 49
                },
                "params": [
                  {
                    "kind": "identifier",
                    "name": "value",
                    "optional": false,
                    "tsType": {
                      "kind": "union",
                      "value": [
                        {
                          "repr": "number",
                          "kind": "keyword",
                          "value": "number"
                        },
                        {
                          "repr": "string",
                          "kind": "keyword",
                          "value": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  ]
}