@mountainpass/problem-document 0.0.3 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/.commitlintrc.json +6 -0
  2. package/.gitattributes +4 -0
  3. package/.husky/commit-msg +1 -2
  4. package/.husky/pre-commit +2 -3
  5. package/.projenrc.ts +35 -0
  6. package/README.md +11 -1
  7. package/cspell.json +13 -0
  8. package/docs/.nojekyll +1 -0
  9. package/docs/assets/highlight.css +57 -0
  10. package/docs/assets/icons.css +1043 -0
  11. package/docs/assets/{images/icons.png → icons.png} +0 -0
  12. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  13. package/docs/assets/main.js +52 -0
  14. package/docs/assets/search.js +1 -0
  15. package/docs/assets/style.css +1414 -0
  16. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  17. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  18. package/docs/classes/ProblemDocument.html +34 -285
  19. package/docs/index.html +8 -108
  20. package/docs/modules.html +27 -206
  21. package/package.json +22 -10
  22. package/commitlint.config.js +0 -1
  23. package/docs/assets/css/main.css +0 -2660
  24. package/docs/assets/js/main.js +0 -248
  25. package/docs/assets/js/search.js +0 -1
package/docs/assets/{images/widgets.png → widgets.png} RENAMED
File without changes
package/docs/classes/ProblemDocument.html CHANGED
@@ -1,285 +1,34 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>ProblemDocument | @mountainpass/problem-document</title>
7
- <meta name="description" content="Documentation for @mountainpass/problem-document">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">@mountainpass/problem-document</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <ul class="tsd-breadcrumb">
54
- <li>
55
- <a href="../modules.html">@mountainpass/problem-document</a>
56
- </li>
57
- <li>
58
- <a href="ProblemDocument.html">ProblemDocument</a>
59
- </li>
60
- </ul>
61
- <h1>Class ProblemDocument</h1>
62
- </div>
63
- </div>
64
- </header>
65
- <div class="container container-main">
66
- <div class="row">
67
- <div class="col-8 col-content">
68
- <section class="tsd-panel tsd-comment">
69
- <div class="tsd-comment tsd-typography">
70
- <div class="lead">
71
- <p>This class implements RFC7807 &quot;problem detail&quot;, a way to carry machine-
72
- readable details of errors in a HTTP response to avoid the need to
73
- define new error response formats for HTTP APIs.</p>
74
- </div>
75
- <p>Official Documentation @ <a href="https://datatracker.ietf.org/doc/html/rfc7807">https://datatracker.ietf.org/doc/html/rfc7807</a></p>
76
- <p>Consumers MUST use the &quot;type&quot; string as the primary identifier for
77
- the problem type; the &quot;title&quot; string is advisory and included only
78
- for users who are not aware of the semantics of the URI and do not
79
- have the ability to discover them (e.g., offline log analysis).
80
- Consumers SHOULD NOT automatically dereference the type URI.</p>
81
- <p>The &quot;status&quot; member, if present, is only advisory; it conveys the
82
- HTTP status code used for the convenience of the consumer.
83
- Generators MUST use the same status code in the actual HTTP response,
84
- to assure that generic HTTP software that does not understand this
85
- format still behaves correctly. See Section 5 for further caveats
86
- regarding its use.</p>
87
- <p>Consumers can use the status member to determine what the original
88
- status code used by the generator was, in cases where it has been
89
- changed (e.g., by an intermediary or cache), and when message bodies
90
- persist without HTTP information. Generic HTTP software will still
91
- use the HTTP status code.</p>
92
- <p>The &quot;detail&quot; member, if present, ought to focus on helping the client
93
- correct the problem, rather than giving debugging information.</p>
94
- <p>Consumers SHOULD NOT parse the &quot;detail&quot; member for information;
95
- extensions are more suitable and less error-prone ways to obtain such
96
- information.</p>
97
- <p>Note that both {@link BaseProblemDocumentProperties.type type} and {@link BaseProblemDocumentProperties.instance instance} accept relative URIs; this means
98
- that they must be resolved relative to the document&#39;s base URI, as
99
- per <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-5" class="external">[RFC3986], Section 5</a>.</p>
100
- </div>
101
- </section>
102
- <section class="tsd-panel tsd-hierarchy">
103
- <h3>Hierarchy</h3>
104
- <ul class="tsd-hierarchy">
105
- <li>
106
- <span class="target">ProblemDocument</span>
107
- </li>
108
- </ul>
109
- </section>
110
- <section class="tsd-panel">
111
- <h3>Implements</h3>
112
- <ul class="tsd-hierarchy">
113
- <li><a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a></li>
114
- </ul>
115
- </section>
116
- <section class="tsd-panel tsd-kind-class">
117
- <h3 class="tsd-before-signature">Indexable</h3>
118
- <div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div>
119
- </section>
120
- <section class="tsd-panel-group tsd-index-group">
121
- <h2>Index</h2>
122
- <section class="tsd-panel tsd-index-panel">
123
- <div class="tsd-index-content">
124
- <section class="tsd-index-section ">
125
- <h3>Constructors</h3>
126
- <ul class="tsd-index-list">
127
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ProblemDocument.html#constructor" class="tsd-kind-icon">constructor</a></li>
128
- </ul>
129
- </section>
130
- <section class="tsd-index-section ">
131
- <h3>Properties</h3>
132
- <ul class="tsd-index-list">
133
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#detail" class="tsd-kind-icon">detail</a></li>
134
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#instance" class="tsd-kind-icon">instance</a></li>
135
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#status" class="tsd-kind-icon">status</a></li>
136
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#title" class="tsd-kind-icon">title</a></li>
137
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#type" class="tsd-kind-icon">type</a></li>
138
- </ul>
139
- </section>
140
- </div>
141
- </section>
142
- </section>
143
- <section class="tsd-panel-group tsd-member-group ">
144
- <h2>Constructors</h2>
145
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
146
- <a name="constructor" class="tsd-anchor"></a>
147
- <h3>constructor</h3>
148
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
149
- <li class="tsd-signature tsd-kind-icon">new <wbr>Problem<wbr>Document<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ProblemDocument.html" class="tsd-signature-type" data-tsd-kind="Class">ProblemDocument</a></li>
150
- </ul>
151
- <ul class="tsd-descriptions">
152
- <li class="tsd-description">
153
- <aside class="tsd-sources">
154
- </aside>
155
- <div class="tsd-comment tsd-typography">
156
- <div class="lead">
157
- <p>construct a new ProblemDocument instance</p>
158
- </div>
159
- </div>
160
- <h4 class="tsd-parameters-title">Parameters</h4>
161
- <ul class="tsd-parameters">
162
- <li>
163
- <h5>data: <a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a></h5>
164
- <div class="tsd-comment tsd-typography">
165
- <div class="lead">
166
- <p>properties to assign to the new instance</p>
167
- </div>
168
- </div>
169
- </li>
170
- </ul>
171
- <h4 class="tsd-returns-title">Returns <a href="ProblemDocument.html" class="tsd-signature-type" data-tsd-kind="Class">ProblemDocument</a></h4>
172
- </li>
173
- </ul>
174
- </section>
175
- </section>
176
- <section class="tsd-panel-group tsd-member-group ">
177
- <h2>Properties</h2>
178
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
179
- <a name="detail" class="tsd-anchor"></a>
180
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> detail</h3>
181
- <div class="tsd-signature tsd-kind-icon">detail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
182
- <aside class="tsd-sources">
183
- <p>Implementation of ProblemDocumentProperties.detail</p>
184
- </aside>
185
- </section>
186
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
187
- <a name="instance" class="tsd-anchor"></a>
188
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> instance</h3>
189
- <div class="tsd-signature tsd-kind-icon">instance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
190
- <aside class="tsd-sources">
191
- <p>Implementation of ProblemDocumentProperties.instance</p>
192
- </aside>
193
- </section>
194
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
195
- <a name="status" class="tsd-anchor"></a>
196
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
197
- <div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">StatusCode</span></div>
198
- <aside class="tsd-sources">
199
- <p>Implementation of ProblemDocumentProperties.status</p>
200
- </aside>
201
- </section>
202
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
203
- <a name="title" class="tsd-anchor"></a>
204
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
205
- <div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
206
- <aside class="tsd-sources">
207
- <p>Implementation of ProblemDocumentProperties.title</p>
208
- </aside>
209
- </section>
210
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
211
- <a name="type" class="tsd-anchor"></a>
212
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
213
- <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
214
- <aside class="tsd-sources">
215
- <p>Implementation of ProblemDocumentProperties.type</p>
216
- </aside>
217
- </section>
218
- </section>
219
- </div>
220
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
221
- <nav class="tsd-navigation primary">
222
- <ul>
223
- <li class=" ">
224
- <a href="../modules.html">Exports</a>
225
- </li>
226
- </ul>
227
- </nav>
228
- <nav class="tsd-navigation secondary menu-sticky">
229
- <ul class="before-current">
230
- </ul>
231
- <ul class="current">
232
- <li class="current tsd-kind-class">
233
- <a href="ProblemDocument.html" class="tsd-kind-icon">Problem<wbr>Document</a>
234
- <ul>
235
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
236
- <a href="ProblemDocument.html#constructor" class="tsd-kind-icon">constructor</a>
237
- </li>
238
- <li class=" tsd-kind-property tsd-parent-kind-class">
239
- <a href="ProblemDocument.html#detail" class="tsd-kind-icon">detail</a>
240
- </li>
241
- <li class=" tsd-kind-property tsd-parent-kind-class">
242
- <a href="ProblemDocument.html#instance" class="tsd-kind-icon">instance</a>
243
- </li>
244
- <li class=" tsd-kind-property tsd-parent-kind-class">
245
- <a href="ProblemDocument.html#status" class="tsd-kind-icon">status</a>
246
- </li>
247
- <li class=" tsd-kind-property tsd-parent-kind-class">
248
- <a href="ProblemDocument.html#title" class="tsd-kind-icon">title</a>
249
- </li>
250
- <li class=" tsd-kind-property tsd-parent-kind-class">
251
- <a href="ProblemDocument.html#type" class="tsd-kind-icon">type</a>
252
- </li>
253
- </ul>
254
- </li>
255
- </ul>
256
- <ul class="after-current">
257
- <li class=" tsd-kind-type-alias">
258
- <a href="../modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties</a>
259
- </li>
260
- <li class=" tsd-kind-type-alias">
261
- <a href="../modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr>Document<wbr>Properties</a>
262
- </li>
263
- </ul>
264
- </nav>
265
- </div>
266
- </div>
267
- </div>
268
- <footer class="with-border-bottom">
269
- <div class="container">
270
- <h2>Legend</h2>
271
- <div class="tsd-legend-group">
272
- <ul class="tsd-legend">
273
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
274
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
275
- </ul>
276
- </div>
277
- </div>
278
- </footer>
279
- <div class="container tsd-generator">
280
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
281
- </div>
282
- <div class="overlay"></div>
283
- <script src="../assets/js/main.js"></script>
284
- </body>
285
- </html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ProblemDocument | @mountainpass/problem-document</title><meta name="description" content="Documentation for @mountainpass/problem-document"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@mountainpass/problem-document</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@mountainpass/problem-document</a></li><li><a href="ProblemDocument.html">ProblemDocument</a></li></ul><h1>Class ProblemDocument </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>This class implements RFC7807 &quot;problem detail&quot;, a way to carry machine-
3
+ readable details of errors in a HTTP response to avoid the need to
4
+ define new error response formats for HTTP APIs.</p>
5
+ </div><div><p>Official Documentation @ <a href="https://datatracker.ietf.org/doc/html/rfc7807">https://datatracker.ietf.org/doc/html/rfc7807</a></p>
6
+ <p>Consumers MUST use the &quot;type&quot; string as the primary identifier for
7
+ the problem type; the &quot;title&quot; string is advisory and included only
8
+ for users who are not aware of the semantics of the URI and do not
9
+ have the ability to discover them (e.g., offline log analysis).
10
+ Consumers SHOULD NOT automatically dereference the type URI.</p>
11
+ <p>The &quot;status&quot; member, if present, is only advisory; it conveys the
12
+ HTTP status code used for the convenience of the consumer.
13
+ Generators MUST use the same status code in the actual HTTP response,
14
+ to assure that generic HTTP software that does not understand this
15
+ format still behaves correctly. See Section 5 for further caveats
16
+ regarding its use.</p>
17
+ <p>Consumers can use the status member to determine what the original
18
+ status code used by the generator was, in cases where it has been
19
+ changed (e.g., by an intermediary or cache), and when message bodies
20
+ persist without HTTP information. Generic HTTP software will still
21
+ use the HTTP status code.</p>
22
+ <p>The &quot;detail&quot; member, if present, ought to focus on helping the client
23
+ correct the problem, rather than giving debugging information.</p>
24
+ <p>Consumers SHOULD NOT parse the &quot;detail&quot; member for information;
25
+ extensions are more suitable and less error-prone ways to obtain such
26
+ information.</p>
27
+ <p>Note that both {@link BaseProblemDocumentProperties.type type} and {@link BaseProblemDocumentProperties.instance instance} accept relative URIs; this means
28
+ that they must be resolved relative to the document&#39;s base URI, as
29
+ per <a href="https://datatracker.ietf.org/doc/html/rfc3986#section-5" class="external">[RFC3986], Section 5</a>.</p>
30
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ProblemDocument</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a></li></ul></section><section class="tsd-panel tsd-kind-class"><h3 class="tsd-before-signature">Indexable</h3><div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ProblemDocument.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#detail" class="tsd-kind-icon">detail</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#instance" class="tsd-kind-icon">instance</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#type" class="tsd-kind-icon">type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Problem<wbr/>Document<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ProblemDocument.html" class="tsd-signature-type" data-tsd-kind="Class">ProblemDocument</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
31
+ <p>construct a new ProblemDocument instance</p>
32
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <a href="../modules.html#ProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">ProblemDocumentProperties</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
33
+ <p>properties to assign to the new instance</p>
34
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ProblemDocument.html" class="tsd-signature-type" data-tsd-kind="Class">ProblemDocument</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="detail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> detail<a href="#detail" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">detail<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of ProblemDocumentProperties.detail</p></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="instance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> instance<a href="#instance" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">instance<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of ProblemDocumentProperties.instance</p></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> status<a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StatusCode</span></div><aside class="tsd-sources"><p>Implementation of ProblemDocumentProperties.status</p></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="title" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> title<a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of ProblemDocumentProperties.title</p></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Implementation of ProblemDocumentProperties.type</p></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ProblemDocument.html" class="tsd-kind-icon">Problem<wbr/>Document</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ProblemDocument.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#detail" class="tsd-kind-icon">detail</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#instance" class="tsd-kind-icon">instance</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#status" class="tsd-kind-icon">status</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="ProblemDocument.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/index.html CHANGED
@@ -1,108 +1,8 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>@mountainpass/problem-document</title>
7
- <meta name="description" content="Documentation for @mountainpass/problem-document">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="assets/css/main.css">
10
- <script async src="assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="index.html" class="title">@mountainpass/problem-document</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <h1>@mountainpass/problem-document</h1>
54
- </div>
55
- </div>
56
- </header>
57
- <div class="container container-main">
58
- <div class="row">
59
- <div class="col-8 col-content">
60
- <div class="tsd-panel tsd-typography">
61
- <a href="#problem-document" id="problem-document" style="color: inherit; text-decoration: none;">
62
- <h1>problem-document</h1>
63
- </a>
64
- <p>A basic RFC7807 Problem Document with basic type checking and autocomplete</p>
65
- </div>
66
- </div>
67
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
68
- <nav class="tsd-navigation primary">
69
- <ul>
70
- <li class=" ">
71
- <a href="modules.html">Exports</a>
72
- </li>
73
- </ul>
74
- </nav>
75
- <nav class="tsd-navigation secondary menu-sticky">
76
- <ul class="before-current">
77
- <li class=" tsd-kind-class">
78
- <a href="classes/ProblemDocument.html" class="tsd-kind-icon">Problem<wbr>Document</a>
79
- </li>
80
- <li class=" tsd-kind-type-alias">
81
- <a href="modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties</a>
82
- </li>
83
- <li class=" tsd-kind-type-alias">
84
- <a href="modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr>Document<wbr>Properties</a>
85
- </li>
86
- </ul>
87
- </nav>
88
- </div>
89
- </div>
90
- </div>
91
- <footer class="with-border-bottom">
92
- <div class="container">
93
- <h2>Legend</h2>
94
- <div class="tsd-legend-group">
95
- <ul class="tsd-legend">
96
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
97
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
98
- </ul>
99
- </div>
100
- </div>
101
- </footer>
102
- <div class="container tsd-generator">
103
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
104
- </div>
105
- <div class="overlay"></div>
106
- <script src="assets/js/main.js"></script>
107
- </body>
108
- </html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@mountainpass/problem-document</title><meta name="description" content="Documentation for @mountainpass/problem-document"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@mountainpass/problem-document</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@mountainpass/problem-document </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
2
+ <a href="#problem-document" id="problem-document" style="color: inherit; text-decoration: none;">
3
+ <h1>problem-document</h1>
4
+ </a>
5
+ <p>A basic RFC7807 Problem Details document with basic type checking and autocomplete A basic RFC7807 Problem Details document with basic type checking and autocomplete</p>
6
+ <pre><code class="language-js"><span class="hl-0">let</span><span class="hl-1"> </span><span class="hl-2">foo</span><span class="hl-1"> = </span><span class="hl-2">bar</span><br/><span class="hl-2">foo</span><span class="hl-1">.</span><span class="hl-3">forEach</span><span class="hl-1">(</span><span class="hl-2">efddd</span><span class="hl-1"> </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">efddd</span><span class="hl-1"> = </span><span class="hl-4">24</span><br/><span class="hl-1">})</span>
7
+ </code></pre>
8
+ </div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/ProblemDocument.html" class="tsd-kind-icon">Problem<wbr/>Document</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr/>Problem<wbr/>Document<wbr/>Properties</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr/>Document<wbr/>Properties</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>