@coveo/push-api-client 2.4.18 → 2.4.28

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 (47) hide show
  1. package/dist/docs/assets/highlight.css +49 -0
  2. package/dist/docs/assets/main.js +3 -3
  3. package/dist/docs/assets/search.js +1 -1
  4. package/dist/docs/assets/style.css +6 -82
  5. package/dist/docs/classes/AnySecurityIdentityBuilder.html +15 -11
  6. package/dist/docs/classes/CatalogSource.html +67 -55
  7. package/dist/docs/classes/DocumentBuilder.html +139 -112
  8. package/dist/docs/classes/FieldAnalyser.html +59 -50
  9. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +11 -7
  10. package/dist/docs/classes/PushSource.html +96 -76
  11. package/dist/docs/classes/UserSecurityIdentityBuilder.html +11 -7
  12. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +11 -7
  13. package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +17 -14
  14. package/dist/docs/classes/errors.InvalidDocument.html +17 -14
  15. package/dist/docs/classes/errors.InvalidPermanentId.html +17 -14
  16. package/dist/docs/classes/errors.NotAFileError.html +17 -14
  17. package/dist/docs/classes/errors.NotAJsonFileError.html +17 -14
  18. package/dist/docs/classes/errors.PrivilegeError.html +18 -15
  19. package/dist/docs/classes/errors.UnsupportedAttribute.html +17 -14
  20. package/dist/docs/classes/errors.UnsupportedFieldError.html +27 -23
  21. package/dist/docs/enums/PlatformEnvironment.html +7 -5
  22. package/dist/docs/enums/Region.html +3 -1
  23. package/dist/docs/enums/SourceVisibility.html +3 -1
  24. package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +4 -3
  25. package/dist/docs/index.html +49 -2
  26. package/dist/docs/interfaces/BatchUpdateDocuments.html +5 -3
  27. package/dist/docs/interfaces/Document.html +38 -36
  28. package/dist/docs/interfaces/SecurityIdentity.html +8 -6
  29. package/dist/docs/interfaces/SecurityIdentityBuilder.html +7 -4
  30. package/dist/docs/interfaces/UploadBatchCallbackData.html +8 -6
  31. package/dist/docs/modules/errors.html +3 -1
  32. package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
  33. package/dist/docs/types/CompressionType.html +1 -1
  34. package/dist/docs/types/FailedUploadCallback.html +2 -3
  35. package/dist/docs/types/Metadata.html +1 -1
  36. package/dist/docs/types/MetadataValue.html +1 -1
  37. package/dist/docs/types/PlatformUrlOptions.html +1 -1
  38. package/dist/docs/types/SecurityIdentityType.html +1 -1
  39. package/dist/docs/types/SuccessfulUploadCallback.html +2 -3
  40. package/dist/docs/types/Transformer.html +2 -3
  41. package/dist/docs/variables/BuiltInTransformers.html +1 -1
  42. package/dist/docs/variables/Source.html +1 -1
  43. package/dist/source/catalog.stream.spec.js +13 -0
  44. package/dist/source/catalog.stream.spec.js.map +1 -1
  45. package/dist/source/documentUploader.js +3 -2
  46. package/dist/source/documentUploader.js.map +1 -1
  47. package/package.json +13 -13
package/dist/docs/classes/UserSecurityIdentityBuilder.html CHANGED
@@ -25,7 +25,9 @@
25
25
  <section class="tsd-panel">
26
26
  <h4>Implements</h4>
27
27
  <ul class="tsd-hierarchy">
28
- <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section>
28
+ <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
29
+ <ul>
30
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
29
31
  <section class="tsd-panel-group tsd-index-group">
30
32
  <section class="tsd-panel tsd-index-panel">
31
33
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -44,8 +46,7 @@
44
46
  <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
45
47
  <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
46
48
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
47
- <li class="tsd-signature" id="constructor.new_UserSecurityIdentityBuilder">new <wbr/>User<wbr/>Security<wbr/>Identity<wbr/>Builder<span class="tsd-signature-symbol">(</span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, securityProvider<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></li></ul>
48
- <ul class="tsd-descriptions">
49
+ <li class="tsd-signature tsd-anchor-link" id="constructor.new_UserSecurityIdentityBuilder">new <wbr/>User<wbr/>Security<wbr/>Identity<wbr/>Builder<span class="tsd-signature-symbol">(</span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, securityProvider<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a><a href="#constructor.new_UserSecurityIdentityBuilder" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
49
50
  <li class="tsd-description">
50
51
  <div class="tsd-comment tsd-typography"><p>Pass either a single user, or an array of user to create multiple identities.</p>
51
52
  </div>
@@ -56,20 +57,23 @@
56
57
  <h5>user: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li>
57
58
  <li>
58
59
  <h5>securityProvider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Email Security Provider&#39;</span></h5></li></ul></div>
59
- <h4 class="tsd-returns-title">Returns <a href="UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></h4></li></ul></section></section>
60
+ <h4 class="tsd-returns-title">Returns <a href="UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
61
+ <ul>
62
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
60
63
  <section class="tsd-panel-group tsd-member-group">
61
64
  <h2>Methods</h2>
62
65
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
63
66
  <h3 class="tsd-anchor-link"><span>build</span><a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
64
67
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
65
- <li class="tsd-signature" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></li></ul>
66
- <ul class="tsd-descriptions">
68
+ <li class="tsd-signature tsd-anchor-link" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><a href="#build.build-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
67
69
  <li class="tsd-description">
68
70
  <div class="tsd-comment tsd-typography"><p>Build and return the security identity or identities.</p>
69
71
 
70
72
  <h3>Returns</h3></div>
71
73
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
72
- <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p></aside></li></ul></section></section></div>
74
+ <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
75
+ <ul>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
73
77
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
74
78
  <div class="tsd-navigation settings">
75
79
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html CHANGED
@@ -25,7 +25,9 @@
25
25
  <section class="tsd-panel">
26
26
  <h4>Implements</h4>
27
27
  <ul class="tsd-hierarchy">
28
- <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section>
28
+ <li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
29
+ <ul>
30
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
29
31
  <section class="tsd-panel-group tsd-index-group">
30
32
  <section class="tsd-panel tsd-index-panel">
31
33
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -44,8 +46,7 @@
44
46
  <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
45
47
  <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
46
48
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
47
- <li class="tsd-signature" id="constructor.new_VirtualGroupSecurityIdentityBuilder">new <wbr/>Virtual<wbr/>Group<wbr/>Security<wbr/>Identity<wbr/>Builder<span class="tsd-signature-symbol">(</span>virtualGroup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, securityProvider<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></li></ul>
48
- <ul class="tsd-descriptions">
49
+ <li class="tsd-signature tsd-anchor-link" id="constructor.new_VirtualGroupSecurityIdentityBuilder">new <wbr/>Virtual<wbr/>Group<wbr/>Security<wbr/>Identity<wbr/>Builder<span class="tsd-signature-symbol">(</span>virtualGroup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, securityProvider<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a><a href="#constructor.new_VirtualGroupSecurityIdentityBuilder" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
49
50
  <li class="tsd-description">
50
51
  <div class="tsd-comment tsd-typography"><p>Pass either a single <code>virtualGroup</code>, or an array of <code>virtualGroup</code> to create multiple identities.</p>
51
52
  </div>
@@ -56,20 +57,23 @@
56
57
  <h5>virtualGroup: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li>
57
58
  <li>
58
59
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
59
- <h4 class="tsd-returns-title">Returns <a href="VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></h4></li></ul></section></section>
60
+ <h4 class="tsd-returns-title">Returns <a href="VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
61
+ <ul>
62
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
60
63
  <section class="tsd-panel-group tsd-member-group">
61
64
  <h2>Methods</h2>
62
65
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
63
66
  <h3 class="tsd-anchor-link"><span>build</span><a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
64
67
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
65
- <li class="tsd-signature" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></li></ul>
66
- <ul class="tsd-descriptions">
68
+ <li class="tsd-signature tsd-anchor-link" id="build.build-1">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><a href="#build.build-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
67
69
  <li class="tsd-description">
68
70
  <div class="tsd-comment tsd-typography"><p>Build and return the security identity or identities.</p>
69
71
 
70
72
  <h3>Returns</h3></div>
71
73
  <h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
72
- <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p></aside></li></ul></section></section></div>
74
+ <p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
75
+ <ul>
76
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
73
77
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
74
78
  <div class="tsd-navigation settings">
75
79
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/dist/docs/classes/errors.FieldTypeInconsistencyError.html CHANGED
@@ -19,7 +19,9 @@
19
19
  <ul class="tsd-hierarchy">
20
20
  <li><span class="tsd-signature-type">PushApiClientBaseError</span>
21
21
  <ul class="tsd-hierarchy">
22
- <li><span class="target">FieldTypeInconsistencyError</span></li></ul></li></ul></section>
22
+ <li><span class="target">FieldTypeInconsistencyError</span></li></ul></li></ul></section><aside class="tsd-sources">
23
+ <ul>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/fieldErrors.ts#L5">src/errors/fieldErrors.ts:5</a></li></ul></aside>
23
25
  <section class="tsd-panel-group tsd-index-group">
24
26
  <section class="tsd-panel tsd-index-panel">
25
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,8 +35,8 @@
33
35
  <h3 class="tsd-index-heading">Properties</h3>
34
36
  <div class="tsd-index-list"><a href="errors.FieldTypeInconsistencyError.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>message</span></a>
35
37
  <a href="errors.FieldTypeInconsistencyError.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
36
- <a href="errors.FieldTypeInconsistencyError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
37
- <a href="errors.FieldTypeInconsistencyError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
38
+ <a href="errors.FieldTypeInconsistencyError.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
39
+ <a href="errors.FieldTypeInconsistencyError.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
38
40
  <a href="errors.FieldTypeInconsistencyError.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
39
41
  </div></section>
40
42
  <section class="tsd-index-section">
@@ -46,8 +48,7 @@
46
48
  <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
47
49
  <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
48
50
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
49
- <li class="tsd-signature" id="constructor.new_FieldTypeInconsistencyError">new <wbr/>Field<wbr/>Type<wbr/>Inconsistency<wbr/>Error<span class="tsd-signature-symbol">(</span>inconsitencies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Inconsistencies</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.FieldTypeInconsistencyError.html" class="tsd-signature-type" data-tsd-kind="Class">FieldTypeInconsistencyError</a></li></ul>
50
- <ul class="tsd-descriptions">
51
+ <li class="tsd-signature tsd-anchor-link" id="constructor.new_FieldTypeInconsistencyError">new <wbr/>Field<wbr/>Type<wbr/>Inconsistency<wbr/>Error<span class="tsd-signature-symbol">(</span>inconsitencies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Inconsistencies</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.FieldTypeInconsistencyError.html" class="tsd-signature-type" data-tsd-kind="Class">FieldTypeInconsistencyError</a><a href="#constructor.new_FieldTypeInconsistencyError" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
51
52
  <li class="tsd-description">
52
53
  <div class="tsd-parameters">
53
54
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -55,7 +56,9 @@
55
56
  <li>
56
57
  <h5>inconsitencies: <span class="tsd-signature-type">Inconsistencies</span></h5></li></ul></div>
57
58
  <h4 class="tsd-returns-title">Returns <a href="errors.FieldTypeInconsistencyError.html" class="tsd-signature-type" data-tsd-kind="Class">FieldTypeInconsistencyError</a></h4><aside class="tsd-sources">
58
- <p>Overrides PushApiClientBaseError.constructor</p></aside></li></ul></section></section>
59
+ <p>Overrides PushApiClientBaseError.constructor</p>
60
+ <ul>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/fieldErrors.ts#L7">src/errors/fieldErrors.ts:7</a></li></ul></aside></li></ul></section></section>
59
62
  <section class="tsd-panel-group tsd-member-group">
60
63
  <h2>Properties</h2>
61
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -69,7 +72,7 @@
69
72
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Field Type Inconsistency Error&#39;</span></div><aside class="tsd-sources">
70
73
  <p>Overrides PushApiClientBaseError.name</p>
71
74
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
75
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
73
76
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
74
77
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
75
78
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -84,8 +87,7 @@
84
87
  <ul class="tsd-parameters">
85
88
  <li class="tsd-parameter-signature">
86
89
  <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
87
- <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul>
88
- <ul class="tsd-descriptions">
90
+ <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
89
91
  <li class="tsd-description">
90
92
  <div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p>
91
93
 
@@ -113,8 +115,7 @@
113
115
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
114
116
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
115
117
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
116
- <li class="tsd-signature" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
117
- <ul class="tsd-descriptions">
118
+ <li class="tsd-signature tsd-anchor-link" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
118
119
  <li class="tsd-description">
119
120
  <div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p>
120
121
  </div>
@@ -126,7 +127,9 @@
126
127
  <li>
127
128
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul></div>
128
129
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
129
- <p>Inherited from PushApiClientBaseError.captureStackTrace</p></aside></li></ul></section></section></div>
130
+ <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
131
+ <ul>
132
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
130
133
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
131
134
  <div class="tsd-navigation settings">
132
135
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -156,8 +159,8 @@
156
159
  <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="errors.FieldTypeInconsistencyError.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
157
160
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.FieldTypeInconsistencyError.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
158
161
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="errors.FieldTypeInconsistencyError.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
159
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.FieldTypeInconsistencyError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.FieldTypeInconsistencyError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
162
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.FieldTypeInconsistencyError.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
163
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.FieldTypeInconsistencyError.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
161
164
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.FieldTypeInconsistencyError.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
162
165
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.FieldTypeInconsistencyError.html#captureStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div>
163
166
  <div class="container tsd-generator">
package/dist/docs/classes/errors.InvalidDocument.html CHANGED
@@ -19,7 +19,9 @@
19
19
  <ul class="tsd-hierarchy">
20
20
  <li><span class="tsd-signature-type">PushApiClientBaseError</span>
21
21
  <ul class="tsd-hierarchy">
22
- <li><span class="target">InvalidDocument</span></li></ul></li></ul></section>
22
+ <li><span class="target">InvalidDocument</span></li></ul></li></ul></section><aside class="tsd-sources">
23
+ <ul>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/validatorErrors.ts#L17">src/errors/validatorErrors.ts:17</a></li></ul></aside>
23
25
  <section class="tsd-panel-group tsd-index-group">
24
26
  <section class="tsd-panel tsd-index-panel">
25
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,8 +35,8 @@
33
35
  <h3 class="tsd-index-heading">Properties</h3>
34
36
  <div class="tsd-index-list"><a href="errors.InvalidDocument.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>message</span></a>
35
37
  <a href="errors.InvalidDocument.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
36
- <a href="errors.InvalidDocument.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
37
- <a href="errors.InvalidDocument.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
38
+ <a href="errors.InvalidDocument.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
39
+ <a href="errors.InvalidDocument.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
38
40
  <a href="errors.InvalidDocument.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
39
41
  </div></section>
40
42
  <section class="tsd-index-section">
@@ -46,8 +48,7 @@
46
48
  <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
47
49
  <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
48
50
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
49
- <li class="tsd-signature" id="constructor.new_InvalidDocument">new <wbr/>Invalid<wbr/>Document<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathLike</span>, explanation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.InvalidDocument.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidDocument</a></li></ul>
50
- <ul class="tsd-descriptions">
51
+ <li class="tsd-signature tsd-anchor-link" id="constructor.new_InvalidDocument">new <wbr/>Invalid<wbr/>Document<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PathLike</span>, explanation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.InvalidDocument.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidDocument</a><a href="#constructor.new_InvalidDocument" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
51
52
  <li class="tsd-description">
52
53
  <div class="tsd-parameters">
53
54
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -57,7 +58,9 @@
57
58
  <li>
58
59
  <h5>explanation: <span class="tsd-signature-type">string</span></h5></li></ul></div>
59
60
  <h4 class="tsd-returns-title">Returns <a href="errors.InvalidDocument.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidDocument</a></h4><aside class="tsd-sources">
60
- <p>Overrides PushApiClientBaseError.constructor</p></aside></li></ul></section></section>
61
+ <p>Overrides PushApiClientBaseError.constructor</p>
62
+ <ul>
63
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/validatorErrors.ts#L19">src/errors/validatorErrors.ts:19</a></li></ul></aside></li></ul></section></section>
61
64
  <section class="tsd-panel-group tsd-member-group">
62
65
  <h2>Properties</h2>
63
66
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -71,7 +74,7 @@
71
74
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Invalid JSON Document Error&#39;</span></div><aside class="tsd-sources">
72
75
  <p>Overrides PushApiClientBaseError.name</p>
73
76
  <ul>
74
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</a></li></ul></aside></section>
77
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/validatorErrors.ts#L18">src/errors/validatorErrors.ts:18</a></li></ul></aside></section>
75
78
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
76
79
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
77
80
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -86,8 +89,7 @@
86
89
  <ul class="tsd-parameters">
87
90
  <li class="tsd-parameter-signature">
88
91
  <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
89
- <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul>
90
- <ul class="tsd-descriptions">
92
+ <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
91
93
  <li class="tsd-description">
92
94
  <div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p>
93
95
 
@@ -115,8 +117,7 @@
115
117
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
116
118
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
117
119
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
118
- <li class="tsd-signature" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
119
- <ul class="tsd-descriptions">
120
+ <li class="tsd-signature tsd-anchor-link" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
120
121
  <li class="tsd-description">
121
122
  <div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p>
122
123
  </div>
@@ -128,7 +129,9 @@
128
129
  <li>
129
130
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul></div>
130
131
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
131
- <p>Inherited from PushApiClientBaseError.captureStackTrace</p></aside></li></ul></section></section></div>
132
+ <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
133
+ <ul>
134
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
132
135
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
133
136
  <div class="tsd-navigation settings">
134
137
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -158,8 +161,8 @@
158
161
  <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="errors.InvalidDocument.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
159
162
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidDocument.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
160
163
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="errors.InvalidDocument.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
161
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidDocument.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
162
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidDocument.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
164
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidDocument.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
165
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidDocument.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
163
166
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidDocument.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
164
167
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidDocument.html#captureStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div>
165
168
  <div class="container tsd-generator">
package/dist/docs/classes/errors.InvalidPermanentId.html CHANGED
@@ -19,7 +19,9 @@
19
19
  <ul class="tsd-hierarchy">
20
20
  <li><span class="tsd-signature-type">PushApiClientBaseError</span>
21
21
  <ul class="tsd-hierarchy">
22
- <li><span class="target">InvalidPermanentId</span></li></ul></li></ul></section>
22
+ <li><span class="target">InvalidPermanentId</span></li></ul></li></ul></section><aside class="tsd-sources">
23
+ <ul>
24
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/fieldErrors.ts#L27">src/errors/fieldErrors.ts:27</a></li></ul></aside>
23
25
  <section class="tsd-panel-group tsd-index-group">
24
26
  <section class="tsd-panel tsd-index-panel">
25
27
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,8 +35,8 @@
33
35
  <h3 class="tsd-index-heading">Properties</h3>
34
36
  <div class="tsd-index-list"><a href="errors.InvalidPermanentId.html#message" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>message</span></a>
35
37
  <a href="errors.InvalidPermanentId.html#name" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>name</span></a>
36
- <a href="errors.InvalidPermanentId.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack</span></a>
37
- <a href="errors.InvalidPermanentId.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace</span></a>
38
+ <a href="errors.InvalidPermanentId.html#stack" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack?</span></a>
39
+ <a href="errors.InvalidPermanentId.html#prepareStackTrace" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>prepare<wbr/>Stack<wbr/>Trace?</span></a>
38
40
  <a href="errors.InvalidPermanentId.html#stackTraceLimit" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>stack<wbr/>Trace<wbr/>Limit</span></a>
39
41
  </div></section>
40
42
  <section class="tsd-index-section">
@@ -46,8 +48,7 @@
46
48
  <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
47
49
  <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
48
50
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
49
- <li class="tsd-signature" id="constructor.new_InvalidPermanentId">new <wbr/>Invalid<wbr/>Permanent<wbr/>Id<span class="tsd-signature-symbol">(</span>field<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.InvalidPermanentId.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidPermanentId</a></li></ul>
50
- <ul class="tsd-descriptions">
51
+ <li class="tsd-signature tsd-anchor-link" id="constructor.new_InvalidPermanentId">new <wbr/>Invalid<wbr/>Permanent<wbr/>Id<span class="tsd-signature-symbol">(</span>field<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.InvalidPermanentId.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidPermanentId</a><a href="#constructor.new_InvalidPermanentId" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
51
52
  <li class="tsd-description">
52
53
  <div class="tsd-parameters">
53
54
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -55,7 +56,9 @@
55
56
  <li>
56
57
  <h5>field: <span class="tsd-signature-type">FieldModel</span></h5></li></ul></div>
57
58
  <h4 class="tsd-returns-title">Returns <a href="errors.InvalidPermanentId.html" class="tsd-signature-type" data-tsd-kind="Class">InvalidPermanentId</a></h4><aside class="tsd-sources">
58
- <p>Overrides PushApiClientBaseError.constructor</p></aside></li></ul></section></section>
59
+ <p>Overrides PushApiClientBaseError.constructor</p>
60
+ <ul>
61
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/fieldErrors.ts#L29">src/errors/fieldErrors.ts:29</a></li></ul></aside></li></ul></section></section>
59
62
  <section class="tsd-panel-group tsd-member-group">
60
63
  <h2>Properties</h2>
61
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
@@ -69,7 +72,7 @@
69
72
  <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;Invalid permanentId field Error&#39;</span></div><aside class="tsd-sources">
70
73
  <p>Overrides PushApiClientBaseError.name</p>
71
74
  <ul>
72
- <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0a7a9a0/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</a></li></ul></aside></section>
75
+ <li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/6f5535c/src/errors/fieldErrors.ts#L28">src/errors/fieldErrors.ts:28</a></li></ul></aside></section>
73
76
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
74
77
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
75
78
  <div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -84,8 +87,7 @@
84
87
  <ul class="tsd-parameters">
85
88
  <li class="tsd-parameter-signature">
86
89
  <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
87
- <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul>
88
- <ul class="tsd-descriptions">
90
+ <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, stackTraces<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallSite</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
89
91
  <li class="tsd-description">
90
92
  <div class="tsd-comment tsd-typography"><p>Optional override for formatting stack traces</p>
91
93
 
@@ -113,8 +115,7 @@
113
115
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
114
116
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Stack<wbr/>Trace</span><a href="#captureStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
115
117
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
116
- <li class="tsd-signature" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
117
- <ul class="tsd-descriptions">
118
+ <li class="tsd-signature tsd-anchor-link" id="captureStackTrace.captureStackTrace-1">capture<wbr/>Stack<wbr/>Trace<span class="tsd-signature-symbol">(</span>targetObject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, constructorOpt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#captureStackTrace.captureStackTrace-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
118
119
  <li class="tsd-description">
119
120
  <div class="tsd-comment tsd-typography"><p>Create .stack property on a target object</p>
120
121
  </div>
@@ -126,7 +127,9 @@
126
127
  <li>
127
128
  <h5><code class="tsd-tag ts-flagOptional">Optional</code> constructorOpt: <span class="tsd-signature-type">Function</span></h5></li></ul></div>
128
129
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
129
- <p>Inherited from PushApiClientBaseError.captureStackTrace</p></aside></li></ul></section></section></div>
130
+ <p>Inherited from PushApiClientBaseError.captureStackTrace</p>
131
+ <ul>
132
+ <li>Defined in node_modules/@types/node/globals.d.ts:4</li></ul></aside></li></ul></section></section></div>
130
133
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
131
134
  <div class="tsd-navigation settings">
132
135
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -156,8 +159,8 @@
156
159
  <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="errors.InvalidPermanentId.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
157
160
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidPermanentId.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>message</a></li>
158
161
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="errors.InvalidPermanentId.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>name</a></li>
159
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidPermanentId.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack</a></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidPermanentId.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace</a></li>
162
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidPermanentId.html#stack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack?</a></li>
163
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidPermanentId.html#prepareStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>prepare<wbr/>Stack<wbr/>Trace?</a></li>
161
164
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidPermanentId.html#stackTraceLimit" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>stack<wbr/>Trace<wbr/>Limit</a></li>
162
165
  <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="errors.InvalidPermanentId.html#captureStackTrace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>capture<wbr/>Stack<wbr/>Trace</a></li></ul></li></ul></nav></div></div>
163
166
  <div class="container tsd-generator">