@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.
- package/.commitlintrc.json +6 -0
- package/.gitattributes +4 -0
- package/.husky/commit-msg +1 -2
- package/.husky/pre-commit +2 -3
- package/.projenrc.ts +35 -0
- package/README.md +11 -1
- package/cspell.json +13 -0
- package/docs/.nojekyll +1 -0
- package/docs/assets/highlight.css +57 -0
- package/docs/assets/icons.css +1043 -0
- package/docs/assets/{images/icons.png → icons.png} +0 -0
- package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
- package/docs/assets/main.js +52 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1414 -0
- package/docs/assets/{images/widgets.png → widgets.png} +0 -0
- package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
- package/docs/classes/ProblemDocument.html +34 -285
- package/docs/index.html +8 -108
- package/docs/modules.html +27 -206
- package/package.json +22 -10
- package/commitlint.config.js +0 -1
- package/docs/assets/css/main.css +0 -2660
- package/docs/assets/js/main.js +0 -248
- package/docs/assets/js/search.js +0 -1
package/docs/modules.html
CHANGED
|
@@ -1,206 +1,27 @@
|
|
|
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
|
-
<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
|
-
<section class="tsd-panel-group tsd-index-group">
|
|
61
|
-
<h2>Index</h2>
|
|
62
|
-
<section class="tsd-panel tsd-index-panel">
|
|
63
|
-
<div class="tsd-index-content">
|
|
64
|
-
<section class="tsd-index-section ">
|
|
65
|
-
<h3>Classes</h3>
|
|
66
|
-
<ul class="tsd-index-list">
|
|
67
|
-
<li class="tsd-kind-class"><a href="classes/ProblemDocument.html" class="tsd-kind-icon">Problem<wbr>Document</a></li>
|
|
68
|
-
</ul>
|
|
69
|
-
</section>
|
|
70
|
-
<section class="tsd-index-section ">
|
|
71
|
-
<h3>Type aliases</h3>
|
|
72
|
-
<ul class="tsd-index-list">
|
|
73
|
-
<li class="tsd-kind-type-alias"><a href="modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties</a></li>
|
|
74
|
-
<li class="tsd-kind-type-alias"><a href="modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr>Document<wbr>Properties</a></li>
|
|
75
|
-
</ul>
|
|
76
|
-
</section>
|
|
77
|
-
</div>
|
|
78
|
-
</section>
|
|
79
|
-
</section>
|
|
80
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
81
|
-
<h2>Type aliases</h2>
|
|
82
|
-
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
83
|
-
<a name="BaseProblemDocumentProperties" class="tsd-anchor"></a>
|
|
84
|
-
<h3>Base<wbr>Problem<wbr>Document<wbr>Properties</h3>
|
|
85
|
-
<div class="tsd-signature tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>detail<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StatusCode</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
|
86
|
-
<aside class="tsd-sources">
|
|
87
|
-
</aside>
|
|
88
|
-
<div class="tsd-comment tsd-typography">
|
|
89
|
-
<div class="lead">
|
|
90
|
-
<p>Base class for Problem Documents, which includes the non-extension fields</p>
|
|
91
|
-
</div>
|
|
92
|
-
</div>
|
|
93
|
-
<div class="tsd-type-declaration">
|
|
94
|
-
<h4>Type declaration</h4>
|
|
95
|
-
<ul class="tsd-parameters">
|
|
96
|
-
<li class="tsd-parameter">
|
|
97
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> detail<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
98
|
-
<div class="tsd-comment tsd-typography">
|
|
99
|
-
<div class="lead">
|
|
100
|
-
<p>A human-readable explanation specific to this occurrence of the problem.</p>
|
|
101
|
-
</div>
|
|
102
|
-
</div>
|
|
103
|
-
</li>
|
|
104
|
-
<li class="tsd-parameter">
|
|
105
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
106
|
-
<div class="tsd-comment tsd-typography">
|
|
107
|
-
<div class="lead">
|
|
108
|
-
<p>A URI reference that identifies the specific
|
|
109
|
-
occurrence of the problem. It may or may not yield further
|
|
110
|
-
information if dereferenced.</p>
|
|
111
|
-
</div>
|
|
112
|
-
</div>
|
|
113
|
-
</li>
|
|
114
|
-
<li class="tsd-parameter">
|
|
115
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StatusCode</span></h5>
|
|
116
|
-
<div class="tsd-comment tsd-typography">
|
|
117
|
-
<div class="lead">
|
|
118
|
-
<p>The HTTP status code (<a href="https://datatracker.ietf.org/doc/html/rfc7231#section-6" class="external">[RFC7231], Section 6</a>)
|
|
119
|
-
generated by the origin server for this occurrence of the problem.</p>
|
|
120
|
-
</div>
|
|
121
|
-
</div>
|
|
122
|
-
</li>
|
|
123
|
-
<li class="tsd-parameter">
|
|
124
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
125
|
-
<div class="tsd-comment tsd-typography">
|
|
126
|
-
<div class="lead">
|
|
127
|
-
<p>A short, human-readable summary of the problem
|
|
128
|
-
type. It SHOULD NOT change from occurrence to occurrence of the
|
|
129
|
-
problem, except for purposes of localization (e.g., using
|
|
130
|
-
proactive content negotiation; see <a href="https://datatracker.ietf.org/doc/html/rfc7231#section-3.4" class="external">[RFC7231], Section 3.4</a>).</p>
|
|
131
|
-
</div>
|
|
132
|
-
</div>
|
|
133
|
-
</li>
|
|
134
|
-
<li class="tsd-parameter">
|
|
135
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
|
136
|
-
<div class="tsd-comment tsd-typography">
|
|
137
|
-
<div class="lead">
|
|
138
|
-
<p>A URI reference [<a href="https://datatracker.ietf.org/doc/html/rfc3986" class="external">RFC3986</a>] that identifies the
|
|
139
|
-
problem type. This specification encourages that, when
|
|
140
|
-
dereferenced, it provide human-readable documentation for the
|
|
141
|
-
problem type (e.g., using HTML [<a href="https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028" class="external">W3C.REC-html5-20141028</a>]). When
|
|
142
|
-
this member is not present, its value is assumed to be
|
|
143
|
-
"about:blank".</p>
|
|
144
|
-
</div>
|
|
145
|
-
</div>
|
|
146
|
-
</li>
|
|
147
|
-
</ul>
|
|
148
|
-
</div>
|
|
149
|
-
</section>
|
|
150
|
-
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
151
|
-
<a name="ProblemDocumentProperties" class="tsd-anchor"></a>
|
|
152
|
-
<h3>Problem<wbr>Document<wbr>Properties</h3>
|
|
153
|
-
<div class="tsd-signature tsd-kind-icon">Problem<wbr>Document<wbr>Properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><a href="modules.html#BaseProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">BaseProblemDocumentProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><a href="modules.html#BaseProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">BaseProblemDocumentProperties</a></div>
|
|
154
|
-
<aside class="tsd-sources">
|
|
155
|
-
</aside>
|
|
156
|
-
<div class="tsd-comment tsd-typography">
|
|
157
|
-
<div class="lead">
|
|
158
|
-
<p>The Problem Document with extensions</p>
|
|
159
|
-
</div>
|
|
160
|
-
<p>Note the use of Omit, this allows auto-completion of the base fields</p>
|
|
161
|
-
</div>
|
|
162
|
-
</section>
|
|
163
|
-
</section>
|
|
164
|
-
</div>
|
|
165
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
166
|
-
<nav class="tsd-navigation primary">
|
|
167
|
-
<ul>
|
|
168
|
-
<li class="current ">
|
|
169
|
-
<a href="modules.html">Exports</a>
|
|
170
|
-
</li>
|
|
171
|
-
</ul>
|
|
172
|
-
</nav>
|
|
173
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
174
|
-
<ul class="before-current">
|
|
175
|
-
<li class=" tsd-kind-class">
|
|
176
|
-
<a href="classes/ProblemDocument.html" class="tsd-kind-icon">Problem<wbr>Document</a>
|
|
177
|
-
</li>
|
|
178
|
-
<li class=" tsd-kind-type-alias">
|
|
179
|
-
<a href="modules.html#BaseProblemDocumentProperties" class="tsd-kind-icon">Base<wbr>Problem<wbr>Document<wbr>Properties</a>
|
|
180
|
-
</li>
|
|
181
|
-
<li class=" tsd-kind-type-alias">
|
|
182
|
-
<a href="modules.html#ProblemDocumentProperties" class="tsd-kind-icon">Problem<wbr>Document<wbr>Properties</a>
|
|
183
|
-
</li>
|
|
184
|
-
</ul>
|
|
185
|
-
</nav>
|
|
186
|
-
</div>
|
|
187
|
-
</div>
|
|
188
|
-
</div>
|
|
189
|
-
<footer class="with-border-bottom">
|
|
190
|
-
<div class="container">
|
|
191
|
-
<h2>Legend</h2>
|
|
192
|
-
<div class="tsd-legend-group">
|
|
193
|
-
<ul class="tsd-legend">
|
|
194
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
195
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
196
|
-
</ul>
|
|
197
|
-
</div>
|
|
198
|
-
</div>
|
|
199
|
-
</footer>
|
|
200
|
-
<div class="container tsd-generator">
|
|
201
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
202
|
-
</div>
|
|
203
|
-
<div class="overlay"></div>
|
|
204
|
-
<script src="assets/js/main.js"></script>
|
|
205
|
-
</body>
|
|
206
|
-
</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"><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>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/ProblemDocument.html" class="tsd-kind-icon">Problem<wbr/>Document</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><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></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="BaseProblemDocumentProperties" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Base<wbr/>Problem<wbr/>Document<wbr/>Properties<a href="#BaseProblemDocumentProperties" 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">Base<wbr/>Problem<wbr/>Document<wbr/>Properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>detail<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StatusCode</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
<p>Base class for Problem Documents, which includes the non-extension fields</p>
|
|
3
|
+
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> detail<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
+
<p>A human-readable explanation specific to this occurrence of the problem.</p>
|
|
5
|
+
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> instance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
+
<p>A URI reference that identifies the specific
|
|
7
|
+
occurrence of the problem. It may or may not yield further
|
|
8
|
+
information if dereferenced.</p>
|
|
9
|
+
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> status<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StatusCode</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
|
+
<p>The HTTP status code (<a href="https://datatracker.ietf.org/doc/html/rfc7231#section-6" class="external">[RFC7231], Section 6</a>)
|
|
11
|
+
generated by the origin server for this occurrence of the problem.</p>
|
|
12
|
+
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> title<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
13
|
+
<p>A short, human-readable summary of the problem
|
|
14
|
+
type. It SHOULD NOT change from occurrence to occurrence of the
|
|
15
|
+
problem, except for purposes of localization (e.g., using
|
|
16
|
+
proactive content negotiation; see <a href="https://datatracker.ietf.org/doc/html/rfc7231#section-3.4" class="external">[RFC7231], Section 3.4</a>).</p>
|
|
17
|
+
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
18
|
+
<p>A URI reference [<a href="https://datatracker.ietf.org/doc/html/rfc3986" class="external">RFC3986</a>] that identifies the
|
|
19
|
+
problem type. This specification encourages that, when
|
|
20
|
+
dereferenced, it provide human-readable documentation for the
|
|
21
|
+
problem type (e.g., using HTML [<a href="https://datatracker.ietf.org/doc/html/rfc7807#ref-W3C.REC-html5-20141028" class="external">W3C.REC-html5-20141028</a>]). When
|
|
22
|
+
this member is not present, its value is assumed to be
|
|
23
|
+
"about:blank".</p>
|
|
24
|
+
</div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ProblemDocumentProperties" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Problem<wbr/>Document<wbr/>Properties<a href="#ProblemDocumentProperties" 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">Problem<wbr/>Document<wbr/>Properties<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><a href="modules.html#BaseProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">BaseProblemDocumentProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><a href="modules.html#BaseProblemDocumentProperties" class="tsd-signature-type" data-tsd-kind="Type alias">BaseProblemDocumentProperties</a></div><div class="tsd-comment tsd-typography"><div class="lead">
|
|
25
|
+
<p>The Problem Document with extensions</p>
|
|
26
|
+
</div><div><p>Note the use of Omit, this allows auto-completion of the base fields</p>
|
|
27
|
+
</div></div></section></section></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>
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mountainpass/problem-document",
|
|
3
|
-
"description": "A basic RFC7807 Problem
|
|
3
|
+
"description": "A basic RFC7807 Problem Details document with basic type checking and autocomplete",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
|
-
"url": "https://github.com/mountain-pass/problem-document"
|
|
6
|
+
"url": "https://github.com/mountain-pass/problem-document.git"
|
|
7
7
|
},
|
|
8
8
|
"scripts": {
|
|
9
9
|
"build": "npx projen build",
|
|
@@ -28,18 +28,19 @@
|
|
|
28
28
|
},
|
|
29
29
|
"author": {
|
|
30
30
|
"name": "Mountain Pass",
|
|
31
|
-
"email": "
|
|
32
|
-
"
|
|
33
|
-
"organization": "Mountain Pass"
|
|
31
|
+
"email": "info@mountain-pass.com.au",
|
|
32
|
+
"organization": true
|
|
34
33
|
},
|
|
35
34
|
"devDependencies": {
|
|
36
35
|
"@commitlint/cli": "^16.2.4",
|
|
37
36
|
"@commitlint/config-conventional": "^16.2.4",
|
|
37
|
+
"@mountainpass/projen-typescript-library": "^0.1.0",
|
|
38
38
|
"@types/http-status-codes": "^1.2.0",
|
|
39
39
|
"@types/jest": "^27.4.1",
|
|
40
40
|
"@types/node": "^12",
|
|
41
41
|
"@typescript-eslint/eslint-plugin": "^5",
|
|
42
42
|
"@typescript-eslint/parser": "^5",
|
|
43
|
+
"cspell": "*",
|
|
43
44
|
"eslint": "^8",
|
|
44
45
|
"eslint-config-prettier": "^8.5.0",
|
|
45
46
|
"eslint-import-resolver-node": "^0.3.6",
|
|
@@ -57,13 +58,13 @@
|
|
|
57
58
|
"prettier": "^2.6.2",
|
|
58
59
|
"projen": "^0.54.50",
|
|
59
60
|
"standard-version": "^9",
|
|
60
|
-
"ts-jest": "^27
|
|
61
|
-
"
|
|
61
|
+
"ts-jest": "^27",
|
|
62
|
+
"ts-node": "^9",
|
|
63
|
+
"typedoc": "^0.22.15",
|
|
62
64
|
"typescript": "^4.6.3"
|
|
63
65
|
},
|
|
64
66
|
"keywords": [
|
|
65
|
-
"
|
|
66
|
-
"problem",
|
|
67
|
+
"problem-details",
|
|
67
68
|
"rfc7807"
|
|
68
69
|
],
|
|
69
70
|
"main": "lib/index.js",
|
|
@@ -72,11 +73,19 @@
|
|
|
72
73
|
"publishConfig": {
|
|
73
74
|
"access": "public"
|
|
74
75
|
},
|
|
75
|
-
"version": "0.0.
|
|
76
|
+
"version": "0.0.6",
|
|
76
77
|
"bugs": {
|
|
77
78
|
"url": "https://github.com/mountain-pass/problem-document/issues"
|
|
78
79
|
},
|
|
79
80
|
"jest": {
|
|
81
|
+
"coverageThreshold": {
|
|
82
|
+
"global": {
|
|
83
|
+
"branches": 100,
|
|
84
|
+
"functions": 100,
|
|
85
|
+
"lines": 100,
|
|
86
|
+
"statements": 100
|
|
87
|
+
}
|
|
88
|
+
},
|
|
80
89
|
"testMatch": [
|
|
81
90
|
"<rootDir>/src/**/__tests__/**/*.ts?(x)",
|
|
82
91
|
"<rootDir>/(test|src)/**/?(*.)+(spec|test).ts?(x)"
|
|
@@ -117,5 +126,8 @@
|
|
|
117
126
|
}
|
|
118
127
|
},
|
|
119
128
|
"types": "lib/index.d.ts",
|
|
129
|
+
"contributors": [
|
|
130
|
+
"Tom Howard <tom@mountainpass.com.au>"
|
|
131
|
+
],
|
|
120
132
|
"//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"."
|
|
121
133
|
}
|
package/commitlint.config.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
module.exports = {extends: ['@commitlint/config-conventional']}
|