@ferricstore/ferricstore 0.11.11 → 0.12.0
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/README.md +16 -1
- package/dist/durability-DlDCsdlo.d.cts +16 -0
- package/dist/durability-DplL0SbW.d.ts +16 -0
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5 -162
- package/dist/index.d.ts +5 -162
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/internal-lEEDZpPH.d.cts +4 -0
- package/dist/internal-lEEDZpPH.d.ts +4 -0
- package/dist/langgraph.cjs +1278 -0
- package/dist/langgraph.cjs.map +1 -0
- package/dist/langgraph.d.cts +148 -0
- package/dist/langgraph.d.ts +148 -0
- package/dist/langgraph.js +1252 -0
- package/dist/langgraph.js.map +1 -0
- package/dist/openai-agents.cjs +580 -0
- package/dist/openai-agents.cjs.map +1 -0
- package/dist/openai-agents.d.cts +44 -0
- package/dist/openai-agents.d.ts +44 -0
- package/dist/openai-agents.js +555 -0
- package/dist/openai-agents.js.map +1 -0
- package/dist/outcomes-BbFDp3AH.d.ts +160 -0
- package/dist/outcomes-DmBwnq0Y.d.cts +160 -0
- package/docs/agent-frameworks.md +159 -0
- package/docs/api/assets/highlight.css +12 -12
- package/docs/api/classes/ClaimHydrationError.html +2 -2
- package/docs/api/classes/ConnectionClosedError.html +2 -2
- package/docs/api/classes/FerricStoreError.html +2 -2
- package/docs/api/classes/FlowAlreadyExistsError.html +2 -2
- package/docs/api/classes/FlowBatchError.html +2 -2
- package/docs/api/classes/FlowNotFoundError.html +2 -2
- package/docs/api/classes/FlowQueryError.html +2 -2
- package/docs/api/classes/FlowWrongStateError.html +2 -2
- package/docs/api/classes/HTTPTransportError.html +2 -2
- package/docs/api/classes/InvalidCommandError.html +2 -2
- package/docs/api/classes/LeaseRenewalError.html +2 -2
- package/docs/api/classes/LockHeldError.html +2 -2
- package/docs/api/classes/LockNotOwnedError.html +2 -2
- package/docs/api/classes/OverloadedError.html +2 -2
- package/docs/api/classes/QueueCompletionError.html +2 -2
- package/docs/api/classes/RequestTimeoutError.html +2 -2
- package/docs/api/classes/RerouteError.html +2 -2
- package/docs/api/classes/StaleLeaseError.html +2 -2
- package/docs/api/classes/StalePolicyGenerationError.html +2 -2
- package/docs/api/index.html +34 -24
- package/docs/api/media/agent-frameworks.md +159 -0
- package/docs/api/media/langgraph.ts +23 -0
- package/docs/api/media/openai-agents-session.ts +13 -0
- package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
- package/package.json +41 -2
|
@@ -152,7 +152,7 @@ not capture any frames.</p>
|
|
|
152
152
|
<div class="tsd-comment tsd-typography"><p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns
|
|
153
153
|
a string representing the location in the code at which
|
|
154
154
|
<code>Error.captureStackTrace()</code> was called.</p>
|
|
155
|
-
<pre><code class="js"><span class="hl-
|
|
155
|
+
<pre><code class="js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myObject</span><span class="hl-1"> = {};</span><br/><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">myObject</span><span class="hl-1">);</span><br/><span class="hl-5">myObject</span><span class="hl-1">.</span><span class="hl-5">stack</span><span class="hl-1">; </span><span class="hl-3">// Similar to `new Error().stack`</span>
|
|
156
156
|
</code><button type="button">Copy</button></pre>
|
|
157
157
|
|
|
158
158
|
<p>The first line of the trace will be prefixed with
|
|
@@ -162,7 +162,7 @@ above <code>constructorOpt</code>, including <code>constructorOpt</code>, will b
|
|
|
162
162
|
generated stack trace.</p>
|
|
163
163
|
<p>The <code>constructorOpt</code> argument is useful for hiding implementation
|
|
164
164
|
details of error generation from the user. For instance:</p>
|
|
165
|
-
<pre><code class="js"><span class="hl-
|
|
165
|
+
<pre><code class="js"><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">a</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// Create an error without stack trace to avoid calculating the stack trace twice.</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">stackTraceLimit</span><span class="hl-1"> } = </span><span class="hl-5">Error</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-9">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">error</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Error</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-5">stackTraceLimit</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-3">// Capture the stack trace above function b</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">error</span><span class="hl-1">, </span><span class="hl-5">b</span><span class="hl-1">); </span><span class="hl-3">// Neither function c, nor b is included in the stack trace</span><br/><span class="hl-1"> </span><span class="hl-4">throw</span><span class="hl-1"> </span><span class="hl-5">error</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">a</span><span class="hl-1">();</span>
|
|
166
166
|
</code><button type="button">Copy</button></pre>
|
|
167
167
|
|
|
168
168
|
</div>
|
|
@@ -120,7 +120,7 @@ not capture any frames.</p>
|
|
|
120
120
|
<div class="tsd-comment tsd-typography"><p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns
|
|
121
121
|
a string representing the location in the code at which
|
|
122
122
|
<code>Error.captureStackTrace()</code> was called.</p>
|
|
123
|
-
<pre><code class="js"><span class="hl-
|
|
123
|
+
<pre><code class="js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myObject</span><span class="hl-1"> = {};</span><br/><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">myObject</span><span class="hl-1">);</span><br/><span class="hl-5">myObject</span><span class="hl-1">.</span><span class="hl-5">stack</span><span class="hl-1">; </span><span class="hl-3">// Similar to `new Error().stack`</span>
|
|
124
124
|
</code><button type="button">Copy</button></pre>
|
|
125
125
|
|
|
126
126
|
<p>The first line of the trace will be prefixed with
|
|
@@ -130,7 +130,7 @@ above <code>constructorOpt</code>, including <code>constructorOpt</code>, will b
|
|
|
130
130
|
generated stack trace.</p>
|
|
131
131
|
<p>The <code>constructorOpt</code> argument is useful for hiding implementation
|
|
132
132
|
details of error generation from the user. For instance:</p>
|
|
133
|
-
<pre><code class="js"><span class="hl-
|
|
133
|
+
<pre><code class="js"><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">a</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// Create an error without stack trace to avoid calculating the stack trace twice.</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">stackTraceLimit</span><span class="hl-1"> } = </span><span class="hl-5">Error</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-9">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">error</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Error</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-5">stackTraceLimit</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-3">// Capture the stack trace above function b</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">error</span><span class="hl-1">, </span><span class="hl-5">b</span><span class="hl-1">); </span><span class="hl-3">// Neither function c, nor b is included in the stack trace</span><br/><span class="hl-1"> </span><span class="hl-4">throw</span><span class="hl-1"> </span><span class="hl-5">error</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">a</span><span class="hl-1">();</span>
|
|
134
134
|
</code><button type="button">Copy</button></pre>
|
|
135
135
|
|
|
136
136
|
</div>
|
|
@@ -162,7 +162,7 @@ not capture any frames.</p>
|
|
|
162
162
|
<div class="tsd-comment tsd-typography"><p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns
|
|
163
163
|
a string representing the location in the code at which
|
|
164
164
|
<code>Error.captureStackTrace()</code> was called.</p>
|
|
165
|
-
<pre><code class="js"><span class="hl-
|
|
165
|
+
<pre><code class="js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myObject</span><span class="hl-1"> = {};</span><br/><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">myObject</span><span class="hl-1">);</span><br/><span class="hl-5">myObject</span><span class="hl-1">.</span><span class="hl-5">stack</span><span class="hl-1">; </span><span class="hl-3">// Similar to `new Error().stack`</span>
|
|
166
166
|
</code><button type="button">Copy</button></pre>
|
|
167
167
|
|
|
168
168
|
<p>The first line of the trace will be prefixed with
|
|
@@ -172,7 +172,7 @@ above <code>constructorOpt</code>, including <code>constructorOpt</code>, will b
|
|
|
172
172
|
generated stack trace.</p>
|
|
173
173
|
<p>The <code>constructorOpt</code> argument is useful for hiding implementation
|
|
174
174
|
details of error generation from the user. For instance:</p>
|
|
175
|
-
<pre><code class="js"><span class="hl-
|
|
175
|
+
<pre><code class="js"><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">a</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// Create an error without stack trace to avoid calculating the stack trace twice.</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">stackTraceLimit</span><span class="hl-1"> } = </span><span class="hl-5">Error</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-9">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">error</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Error</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-5">stackTraceLimit</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-3">// Capture the stack trace above function b</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">error</span><span class="hl-1">, </span><span class="hl-5">b</span><span class="hl-1">); </span><span class="hl-3">// Neither function c, nor b is included in the stack trace</span><br/><span class="hl-1"> </span><span class="hl-4">throw</span><span class="hl-1"> </span><span class="hl-5">error</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">a</span><span class="hl-1">();</span>
|
|
176
176
|
</code><button type="button">Copy</button></pre>
|
|
177
177
|
|
|
178
178
|
</div>
|
|
@@ -149,7 +149,7 @@ not capture any frames.</p>
|
|
|
149
149
|
<div class="tsd-comment tsd-typography"><p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns
|
|
150
150
|
a string representing the location in the code at which
|
|
151
151
|
<code>Error.captureStackTrace()</code> was called.</p>
|
|
152
|
-
<pre><code class="js"><span class="hl-
|
|
152
|
+
<pre><code class="js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myObject</span><span class="hl-1"> = {};</span><br/><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">myObject</span><span class="hl-1">);</span><br/><span class="hl-5">myObject</span><span class="hl-1">.</span><span class="hl-5">stack</span><span class="hl-1">; </span><span class="hl-3">// Similar to `new Error().stack`</span>
|
|
153
153
|
</code><button type="button">Copy</button></pre>
|
|
154
154
|
|
|
155
155
|
<p>The first line of the trace will be prefixed with
|
|
@@ -159,7 +159,7 @@ above <code>constructorOpt</code>, including <code>constructorOpt</code>, will b
|
|
|
159
159
|
generated stack trace.</p>
|
|
160
160
|
<p>The <code>constructorOpt</code> argument is useful for hiding implementation
|
|
161
161
|
details of error generation from the user. For instance:</p>
|
|
162
|
-
<pre><code class="js"><span class="hl-
|
|
162
|
+
<pre><code class="js"><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">a</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// Create an error without stack trace to avoid calculating the stack trace twice.</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">stackTraceLimit</span><span class="hl-1"> } = </span><span class="hl-5">Error</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-9">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">error</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Error</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-5">stackTraceLimit</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-3">// Capture the stack trace above function b</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">error</span><span class="hl-1">, </span><span class="hl-5">b</span><span class="hl-1">); </span><span class="hl-3">// Neither function c, nor b is included in the stack trace</span><br/><span class="hl-1"> </span><span class="hl-4">throw</span><span class="hl-1"> </span><span class="hl-5">error</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">a</span><span class="hl-1">();</span>
|
|
163
163
|
</code><button type="button">Copy</button></pre>
|
|
164
164
|
|
|
165
165
|
</div>
|
|
@@ -146,7 +146,7 @@ not capture any frames.</p>
|
|
|
146
146
|
<div class="tsd-comment tsd-typography"><p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns
|
|
147
147
|
a string representing the location in the code at which
|
|
148
148
|
<code>Error.captureStackTrace()</code> was called.</p>
|
|
149
|
-
<pre><code class="js"><span class="hl-
|
|
149
|
+
<pre><code class="js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myObject</span><span class="hl-1"> = {};</span><br/><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">myObject</span><span class="hl-1">);</span><br/><span class="hl-5">myObject</span><span class="hl-1">.</span><span class="hl-5">stack</span><span class="hl-1">; </span><span class="hl-3">// Similar to `new Error().stack`</span>
|
|
150
150
|
</code><button type="button">Copy</button></pre>
|
|
151
151
|
|
|
152
152
|
<p>The first line of the trace will be prefixed with
|
|
@@ -156,7 +156,7 @@ above <code>constructorOpt</code>, including <code>constructorOpt</code>, will b
|
|
|
156
156
|
generated stack trace.</p>
|
|
157
157
|
<p>The <code>constructorOpt</code> argument is useful for hiding implementation
|
|
158
158
|
details of error generation from the user. For instance:</p>
|
|
159
|
-
<pre><code class="js"><span class="hl-
|
|
159
|
+
<pre><code class="js"><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">a</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// Create an error without stack trace to avoid calculating the stack trace twice.</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">stackTraceLimit</span><span class="hl-1"> } = </span><span class="hl-5">Error</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-9">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">error</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Error</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-5">stackTraceLimit</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-3">// Capture the stack trace above function b</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">error</span><span class="hl-1">, </span><span class="hl-5">b</span><span class="hl-1">); </span><span class="hl-3">// Neither function c, nor b is included in the stack trace</span><br/><span class="hl-1"> </span><span class="hl-4">throw</span><span class="hl-1"> </span><span class="hl-5">error</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">a</span><span class="hl-1">();</span>
|
|
160
160
|
</code><button type="button">Copy</button></pre>
|
|
161
161
|
|
|
162
162
|
</div>
|
|
@@ -149,7 +149,7 @@ not capture any frames.</p>
|
|
|
149
149
|
<div class="tsd-comment tsd-typography"><p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns
|
|
150
150
|
a string representing the location in the code at which
|
|
151
151
|
<code>Error.captureStackTrace()</code> was called.</p>
|
|
152
|
-
<pre><code class="js"><span class="hl-
|
|
152
|
+
<pre><code class="js"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myObject</span><span class="hl-1"> = {};</span><br/><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">myObject</span><span class="hl-1">);</span><br/><span class="hl-5">myObject</span><span class="hl-1">.</span><span class="hl-5">stack</span><span class="hl-1">; </span><span class="hl-3">// Similar to `new Error().stack`</span>
|
|
153
153
|
</code><button type="button">Copy</button></pre>
|
|
154
154
|
|
|
155
155
|
<p>The first line of the trace will be prefixed with
|
|
@@ -159,7 +159,7 @@ above <code>constructorOpt</code>, including <code>constructorOpt</code>, will b
|
|
|
159
159
|
generated stack trace.</p>
|
|
160
160
|
<p>The <code>constructorOpt</code> argument is useful for hiding implementation
|
|
161
161
|
details of error generation from the user. For instance:</p>
|
|
162
|
-
<pre><code class="js"><span class="hl-
|
|
162
|
+
<pre><code class="js"><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">a</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">b</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">();</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">function</span><span class="hl-1"> </span><span class="hl-0">c</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// Create an error without stack trace to avoid calculating the stack trace twice.</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> { </span><span class="hl-7">stackTraceLimit</span><span class="hl-1"> } = </span><span class="hl-5">Error</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-9">0</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">error</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-0">Error</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-5">stackTraceLimit</span><span class="hl-1"> = </span><span class="hl-5">stackTraceLimit</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-3">// Capture the stack trace above function b</span><br/><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">.</span><span class="hl-0">captureStackTrace</span><span class="hl-1">(</span><span class="hl-5">error</span><span class="hl-1">, </span><span class="hl-5">b</span><span class="hl-1">); </span><span class="hl-3">// Neither function c, nor b is included in the stack trace</span><br/><span class="hl-1"> </span><span class="hl-4">throw</span><span class="hl-1"> </span><span class="hl-5">error</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">a</span><span class="hl-1">();</span>
|
|
163
163
|
</code><button type="button">Copy</button></pre>
|
|
164
164
|
|
|
165
165
|
</div>
|