@ferricstore/ferricstore 0.12.0 → 0.12.2
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 +3 -0
- package/dist/langgraph.cjs +395 -125
- package/dist/langgraph.cjs.map +1 -1
- package/dist/langgraph.d.cts +17 -7
- package/dist/langgraph.d.ts +17 -7
- package/dist/langgraph.js +396 -126
- package/dist/langgraph.js.map +1 -1
- package/dist/openai-agents.cjs +161 -24
- package/dist/openai-agents.cjs.map +1 -1
- package/dist/openai-agents.d.cts +10 -4
- package/dist/openai-agents.d.ts +10 -4
- package/dist/openai-agents.js +161 -24
- package/dist/openai-agents.js.map +1 -1
- package/docs/agent-api/assets/hierarchy.js +1 -0
- package/docs/agent-api/assets/highlight.css +92 -0
- package/docs/agent-api/assets/icons.js +18 -0
- package/docs/agent-api/assets/icons.svg +1 -0
- package/docs/agent-api/assets/main.js +60 -0
- package/docs/agent-api/assets/navigation.js +1 -0
- package/docs/agent-api/assets/search.js +1 -0
- package/docs/agent-api/assets/style.css +1648 -0
- package/docs/agent-api/classes/langgraph.FerricStoreSaver.html +297 -0
- package/docs/agent-api/classes/langgraph.FerricStoreStore.html +298 -0
- package/docs/agent-api/classes/langgraph.LangGraphFlow.html +190 -0
- package/docs/agent-api/classes/langgraph.LangGraphFlowContext.html +158 -0
- package/docs/agent-api/classes/langgraph.LangGraphFlowRun.html +133 -0
- package/docs/agent-api/classes/openai-agents.FerricStoreSession.html +241 -0
- package/docs/agent-api/hierarchy.html +44 -0
- package/docs/agent-api/index.html +142 -0
- package/docs/agent-api/interfaces/langgraph.FerricFlowHandlerContext.html +94 -0
- package/docs/agent-api/interfaces/langgraph.FerricStoreCommandClient.html +77 -0
- package/docs/agent-api/interfaces/langgraph.FerricStoreLockOptions.html +81 -0
- package/docs/agent-api/interfaces/langgraph.FerricStoreSaverOptions.html +106 -0
- package/docs/agent-api/interfaces/langgraph.FerricStoreStoreOptions.html +98 -0
- package/docs/agent-api/interfaces/langgraph.InvokableLangGraph.html +83 -0
- package/docs/agent-api/interfaces/langgraph.LangGraphFlowOptions.html +116 -0
- package/docs/agent-api/interfaces/openai-agents.FerricStoreSessionOptions.html +114 -0
- package/docs/agent-api/interfaces/openai-agents.Session.html +208 -0
- package/docs/agent-api/interfaces/openai-agents.SessionHistoryRewriteAwareSession.html +230 -0
- package/docs/agent-api/interfaces/openai-agents.SessionHistoryTransactionAwareSession.html +237 -0
- package/docs/agent-api/modules/langgraph.html +44 -0
- package/docs/agent-api/modules/openai-agents.html +44 -0
- package/docs/agent-api/modules.html +35 -0
- package/docs/agent-api/types/langgraph.LangGraphChannelVersions.html +33 -0
- package/docs/agent-api/types/langgraph.LangGraphInvocationConfig.html +33 -0
- package/docs/agent-api/types/langgraph.LangGraphOutcomeMapper.html +50 -0
- package/docs/agent-api/types/langgraph.LangGraphPendingWrite.html +33 -0
- package/docs/agent-api/types/openai-agents.AgentInputItem.html +35 -0
- package/docs/agent-frameworks.md +25 -8
- package/docs/api/index.html +4 -1
- package/docs/api/media/agent-frameworks.md +25 -8
- package/package.json +5 -5
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@ferricstore/ferricstore</title><meta name="description" content="Documentation for @ferricstore/ferricstore"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="index.html" class="title">@ferricstore/ferricstore</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<h1>@ferricstore/ferricstore</h1></div>
|
|
11
|
+
<div class="tsd-panel tsd-typography"><h1 id="agent-framework-persistence" class="tsd-anchor-link">Agent framework persistence<a href="#agent-framework-persistence" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>
|
|
12
|
+
<p>FerricStore's TypeScript package has optional adapters for LangGraph.js and the
|
|
13
|
+
OpenAI Agents SDK. They live in separate package entry points, so the base SDK
|
|
14
|
+
does not load either framework.</p>
|
|
15
|
+
<h2 id="install" class="tsd-anchor-link">Install<a href="#install" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
16
|
+
<p>For LangGraph.js:</p>
|
|
17
|
+
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@ferricstore/ferricstore</span><span class="hl-1"> </span><span class="hl-2">@langchain/langgraph</span><span class="hl-1"> </span><span class="hl-2">@langchain/core</span>
|
|
18
|
+
</code><button type="button">Copy</button></pre>
|
|
19
|
+
|
|
20
|
+
<p>For the OpenAI Agents SDK:</p>
|
|
21
|
+
<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@ferricstore/ferricstore</span><span class="hl-1"> </span><span class="hl-2">@openai/agents</span>
|
|
22
|
+
</code><button type="button">Copy</button></pre>
|
|
23
|
+
|
|
24
|
+
<p>Both adapters accept the normal <code>FerricStoreClient</code>. Their serialization is
|
|
25
|
+
independent of the client's configured codec.</p>
|
|
26
|
+
<h2 id="langgraphjs-checkpoints" class="tsd-anchor-link">LangGraph.js checkpoints<a href="#langgraphjs-checkpoints" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
27
|
+
<p><code>FerricStoreSaver</code> implements LangGraph's <code>BaseCheckpointSaver</code> contract:</p>
|
|
28
|
+
<pre><code class="ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Annotation</span><span class="hl-1">, </span><span class="hl-4">END</span><span class="hl-1">, </span><span class="hl-4">START</span><span class="hl-1">, </span><span class="hl-4">StateGraph</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@langchain/langgraph"</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">FerricStoreClient</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@ferricstore/ferricstore"</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">FerricStoreSaver</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@ferricstore/ferricstore/langgraph"</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">client</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">FerricStoreClient</span><span class="hl-1">.</span><span class="hl-0">fromUrl</span><span class="hl-1">(</span><span class="hl-2">"ferric://127.0.0.1:6388"</span><span class="hl-1">);</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">saver</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">FerricStoreSaver</span><span class="hl-1">(</span><span class="hl-4">client</span><span class="hl-1">);</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">State</span><span class="hl-1"> = </span><span class="hl-4">Annotation</span><span class="hl-1">.</span><span class="hl-0">Root</span><span class="hl-1">({ </span><span class="hl-4">count:</span><span class="hl-1"> </span><span class="hl-0">Annotation</span><span class="hl-1"><</span><span class="hl-7">number</span><span class="hl-1">>() });</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">graph</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">StateGraph</span><span class="hl-1">(</span><span class="hl-4">State</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">addNode</span><span class="hl-1">(</span><span class="hl-2">"increment"</span><span class="hl-1">, ({ </span><span class="hl-4">count</span><span class="hl-1"> }) </span><span class="hl-5">=></span><span class="hl-1"> ({ </span><span class="hl-4">count:</span><span class="hl-1"> </span><span class="hl-4">count</span><span class="hl-1"> + </span><span class="hl-8">1</span><span class="hl-1"> }))</span><br/><span class="hl-1"> .</span><span class="hl-0">addEdge</span><span class="hl-1">(</span><span class="hl-6">START</span><span class="hl-1">, </span><span class="hl-2">"increment"</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">addEdge</span><span class="hl-1">(</span><span class="hl-2">"increment"</span><span class="hl-1">, </span><span class="hl-6">END</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">compile</span><span class="hl-1">({ </span><span class="hl-4">checkpointer:</span><span class="hl-1"> </span><span class="hl-4">saver</span><span class="hl-1"> });</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">graph</span><span class="hl-1">.</span><span class="hl-0">invoke</span><span class="hl-1">(</span><br/><span class="hl-1"> { </span><span class="hl-4">count:</span><span class="hl-1"> </span><span class="hl-8">0</span><span class="hl-1"> },</span><br/><span class="hl-1"> { </span><span class="hl-4">configurable:</span><span class="hl-1"> { </span><span class="hl-4">thread_id:</span><span class="hl-1"> </span><span class="hl-2">"agent-42"</span><span class="hl-1"> } }</span><br/><span class="hl-1">);</span>
|
|
29
|
+
</code><button type="button">Copy</button></pre>
|
|
30
|
+
|
|
31
|
+
<p>The saver supports named checkpoint namespaces, latest and exact reads,
|
|
32
|
+
ordered and filtered listing, parent chains, pending writes, retry-safe write
|
|
33
|
+
indexes, global listing, and complete thread deletion. It uses LangGraph's
|
|
34
|
+
serializer, so framework-specific values round-trip correctly.</p>
|
|
35
|
+
<p>Checkpoint mutations are serialized per thread with renewable,
|
|
36
|
+
ownership-checked locks. Indexes are published before the final checkpoint
|
|
37
|
+
record; readers validate each record and skip incomplete entries. This makes a
|
|
38
|
+
process failure during publication invisible and a retry safe.</p>
|
|
39
|
+
<h2 id="langgraphjs-long-term-memory" class="tsd-anchor-link">LangGraph.js long-term memory<a href="#langgraphjs-long-term-memory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
40
|
+
<p><code>FerricStoreStore</code> implements <code>BaseStore</code>:</p>
|
|
41
|
+
<pre><code class="ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">FerricStoreStore</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@ferricstore/ferricstore/langgraph"</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">store</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">FerricStoreStore</span><span class="hl-1">(</span><span class="hl-4">client</span><span class="hl-1">);</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">put</span><span class="hl-1">([</span><span class="hl-2">"users"</span><span class="hl-1">, </span><span class="hl-2">"u-42"</span><span class="hl-1">], </span><span class="hl-2">"preferences"</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">language:</span><span class="hl-1"> </span><span class="hl-2">"en"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">notifications:</span><span class="hl-1"> </span><span class="hl-5">true</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">memories</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">search</span><span class="hl-1">([</span><span class="hl-2">"users"</span><span class="hl-1">, </span><span class="hl-2">"u-42"</span><span class="hl-1">], {</span><br/><span class="hl-1"> </span><span class="hl-4">filter:</span><span class="hl-1"> { </span><span class="hl-4">notifications:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
|
42
|
+
</code><button type="button">Copy</button></pre>
|
|
43
|
+
|
|
44
|
+
<p>It supports hierarchical namespaces, atomic per-item mutation ordering,
|
|
45
|
+
batched operations, exact and comparison filters (<code>$eq</code>, <code>$ne</code>, <code>$gt</code>, <code>$gte</code>,
|
|
46
|
+
<code>$lt</code>, <code>$lte</code>, <code>$in</code>, <code>$nin</code>), ordered pagination, namespace listing, updates,
|
|
47
|
+
and deletion.
|
|
48
|
+
Semantic <code>query</code> search currently throws a clear error because no vector index
|
|
49
|
+
is configured; it never silently returns unranked data.</p>
|
|
50
|
+
<h2 id="run-langgraph-inside-ferricflow" class="tsd-anchor-link">Run LangGraph inside FerricFlow<a href="#run-langgraph-inside-ferricflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
51
|
+
<p>The checkpointer makes graph steps resumable. <code>LangGraphFlow</code> adds the durable
|
|
52
|
+
outer lifecycle: leases and fencing, retries, scheduled work, signals,
|
|
53
|
+
approvals, workflow history, and terminal state.</p>
|
|
54
|
+
<pre><code class="ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">LangGraphFlow</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@ferricstore/ferricstore/langgraph"</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">agentFlow</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">LangGraphFlow</span><span class="hl-1">(</span><span class="hl-4">graph</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">interruptState:</span><span class="hl-1"> </span><span class="hl-2">"waiting_for_approval"</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">workflow</span><span class="hl-1">.</span><span class="hl-0">state</span><span class="hl-1">(</span><span class="hl-2">"running"</span><span class="hl-1">, </span><span class="hl-4">agentFlow</span><span class="hl-1">.</span><span class="hl-4">handler</span><span class="hl-1">.</span><span class="hl-0">bind</span><span class="hl-1">(</span><span class="hl-4">agentFlow</span><span class="hl-1">));</span>
|
|
55
|
+
</code><button type="button">Copy</button></pre>
|
|
56
|
+
|
|
57
|
+
<p>By default, the bridge derives a stable LangGraph <code>thread_id</code> from the Flow
|
|
58
|
+
type, partition, and ID. It sends the Flow payload on the first invocation and
|
|
59
|
+
uses <code>null</code> input when a checkpoint already exists. LangGraph runtime context
|
|
60
|
+
includes the active <code>WorkflowContext</code>. Completed graphs become <code>complete()</code>
|
|
61
|
+
outcomes; interrupts can transition to a chosen Flow state or use a custom
|
|
62
|
+
outcome mapper. Call <code>resume(flowContext, value)</code> from a handler to send a
|
|
63
|
+
LangGraph <code>Command({ resume: value })</code>.</p>
|
|
64
|
+
<p>Static <code>invokeOptions</code> and values returned by the <code>config</code> callback are merged,
|
|
65
|
+
including their nested <code>configurable</code> and <code>metadata</code> objects. Dynamic values
|
|
66
|
+
override static values; the bridge always owns <code>thread_id</code>, <code>checkpoint_ns</code>, and
|
|
67
|
+
the <code>ferricflow_*</code> metadata fields. An explicitly supplied runtime context is
|
|
68
|
+
preserved.</p>
|
|
69
|
+
<p>The graph checkpointer and FerricFlow solve different layers and are intended
|
|
70
|
+
to be used together:</p>
|
|
71
|
+
<pre><code class="text">FerricFlow durable run lifecycle
|
|
72
|
+
↓
|
|
73
|
+
LangGraphFlow invocation bridge
|
|
74
|
+
↓
|
|
75
|
+
LangGraph graph + FerricStoreSaver
|
|
76
|
+
↓
|
|
77
|
+
FerricStore
|
|
78
|
+
</code><button type="button">Copy</button></pre>
|
|
79
|
+
|
|
80
|
+
<h2 id="openai-agents-sdk-session" class="tsd-anchor-link">OpenAI Agents SDK Session<a href="#openai-agents-sdk-session" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
81
|
+
<p><code>FerricStoreSession</code> implements the base <code>Session</code> contract plus the optional
|
|
82
|
+
history rewrite and atomic transaction capabilities used by the current
|
|
83
|
+
OpenAI Agents SDK:</p>
|
|
84
|
+
<pre><code class="ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Agent</span><span class="hl-1">, </span><span class="hl-4">run</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@openai/agents"</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">FerricStoreSession</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@ferricstore/ferricstore/openai-agents"</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">session</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">FerricStoreSession</span><span class="hl-1">(</span><span class="hl-4">client</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">sessionId:</span><span class="hl-1"> </span><span class="hl-2">"customer-42"</span><br/><span class="hl-1">});</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">agent</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Agent</span><span class="hl-1">({ </span><span class="hl-4">name:</span><span class="hl-1"> </span><span class="hl-2">"Support"</span><span class="hl-1">, </span><span class="hl-4">instructions:</span><span class="hl-1"> </span><span class="hl-2">"Be helpful."</span><span class="hl-1"> });</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">run</span><span class="hl-1">(</span><span class="hl-4">agent</span><span class="hl-1">, </span><span class="hl-2">"Where is my order?"</span><span class="hl-1">, { </span><span class="hl-4">session</span><span class="hl-1"> });</span>
|
|
85
|
+
</code><button type="button">Copy</button></pre>
|
|
86
|
+
|
|
87
|
+
<p>The adapter provides chronological reads with tail limits, append, pop,
|
|
88
|
+
clear, compaction replacement, function-call history rewrites, and atomic
|
|
89
|
+
<code>append_items</code> / <code>replace_suffix</code> transactions. A transaction stores its
|
|
90
|
+
operation ID and history mutation in one atomic record. Repeating the same
|
|
91
|
+
operation is a no-op; reusing its ID for different content or replacing a
|
|
92
|
+
non-matching suffix fails without changing history. Versioned transaction
|
|
93
|
+
digests are deterministic across worker locales, while receipts created by the
|
|
94
|
+
original locale-ordered format remain valid during migration. When an existing
|
|
95
|
+
deployment also changes locale, pass its previous locale tags through
|
|
96
|
+
<code>legacyReceiptLocales</code> until its receipts have been replayed and upgraded.</p>
|
|
97
|
+
<p>All session mutations use a renewable FerricStore lock for contention control
|
|
98
|
+
and a native compare-and-swap commit for correctness. Reads see either the old
|
|
99
|
+
or new complete session record, never a partial history, and a writer whose
|
|
100
|
+
lock expires cannot overwrite a newer state. <code>clearSession()</code> also clears
|
|
101
|
+
transaction receipts. Session persistence stores conversation history; put the
|
|
102
|
+
overall agent run in FerricFlow when it also needs durable leases, retries,
|
|
103
|
+
timers, signals, or multi-step business state.</p>
|
|
104
|
+
<h2 id="operational-options" class="tsd-anchor-link">Operational options<a href="#operational-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
105
|
+
<p>All three adapters accept <code>keyPrefix</code>, <code>lockTtlMs</code>, <code>lockWaitMs</code>, and
|
|
106
|
+
<code>lockRetryMs</code>. The saver and store also accept <code>scanCount</code>; the saver accepts a
|
|
107
|
+
custom LangGraph serializer. Defaults are suitable for ordinary use. Give
|
|
108
|
+
different applications or environments different prefixes when they share a
|
|
109
|
+
FerricStore deployment. <code>lockRetryMs</code> must be lower than <code>lockTtlMs</code>. Before
|
|
110
|
+
publishing authoritative state, the adapters use FerricStore CAS. LangGraph
|
|
111
|
+
checkpoint deletion advances a thread epoch, and BaseStore deletion writes a
|
|
112
|
+
CAS tombstone; their discovery indexes are append-only and validated on reads.
|
|
113
|
+
These rules make late commands from expired writers harmless even across
|
|
114
|
+
processes.</p>
|
|
115
|
+
</div></div>
|
|
116
|
+
<div class="col-sidebar">
|
|
117
|
+
<div class="page-menu">
|
|
118
|
+
<div class="tsd-navigation settings">
|
|
119
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>
|
|
120
|
+
<h3>Settings</h3></summary>
|
|
121
|
+
<div class="tsd-accordion-details">
|
|
122
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
123
|
+
<ul id="tsd-filter-options">
|
|
124
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
125
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
126
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
127
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
128
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>
|
|
129
|
+
<h3>On This Page</h3></summary>
|
|
130
|
+
<div class="tsd-accordion-details"><a href="#agent-framework-persistence"><span>Agent framework persistence</span></a>
|
|
131
|
+
<ul>
|
|
132
|
+
<li><a href="#install"><span>Install</span></a></li>
|
|
133
|
+
<li><a href="#langgraphjs-checkpoints"><span>Lang<wbr/>Graph.js checkpoints</span></a></li>
|
|
134
|
+
<li><a href="#langgraphjs-long-term-memory"><span>Lang<wbr/>Graph.js long-<wbr/>term memory</span></a></li>
|
|
135
|
+
<li><a href="#run-langgraph-inside-ferricflow"><span>Run <wbr/>Lang<wbr/>Graph inside <wbr/>Ferric<wbr/>Flow</span></a></li>
|
|
136
|
+
<li><a href="#openai-agents-sdk-session"><span>Open<wbr/>AI <wbr/>Agents <wbr/>SDK <wbr/>Session</span></a></li>
|
|
137
|
+
<li><a href="#operational-options"><span>Operational options</span></a></li></ul></div></details></div>
|
|
138
|
+
<div class="site-menu">
|
|
139
|
+
<nav class="tsd-navigation"><a href="modules.html">@ferricstore/ferricstore</a>
|
|
140
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
141
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
142
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FerricFlowHandlerContext | @ferricstore/ferricstore</title><meta name="description" content="Documentation for @ferricstore/ferricstore"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@ferricstore/ferricstore</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="../modules/langgraph.html">langgraph</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">FerricFlowHandlerContext</a></li></ul>
|
|
13
|
+
<h1>Interface FerricFlowHandlerContext</h1></div>
|
|
14
|
+
<section class="tsd-panel tsd-comment">
|
|
15
|
+
<div class="tsd-comment tsd-typography"><p>Structural subset of WorkflowContext required by the LangGraph bridge.</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FerricFlowHandlerContext</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#logicalstate">logicalState</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#partitionkey">partitionKey</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#payload">payload</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#state">state</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#values">values</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
|
+
<ul>
|
|
19
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/flow.ts#L16">langgraph/flow.ts:16</a></li></ul></aside>
|
|
20
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
21
|
+
<section class="tsd-panel tsd-index-panel">
|
|
22
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
23
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
24
|
+
<div class="tsd-accordion-details">
|
|
25
|
+
<section class="tsd-index-section">
|
|
26
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
27
|
+
<div class="tsd-index-list"><a href="#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
|
28
|
+
<a href="#logicalstate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logical<wbr/>State</span></a>
|
|
29
|
+
<a href="#partitionkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>partition<wbr/>Key?</span></a>
|
|
30
|
+
<a href="#payload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>payload</span></a>
|
|
31
|
+
<a href="#state" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a>
|
|
32
|
+
<a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
33
|
+
<a href="#values" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>values</span></a>
|
|
34
|
+
</div></section></div></details></section></section>
|
|
35
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
36
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
37
|
+
<section>
|
|
38
|
+
<section class="tsd-panel tsd-member">
|
|
39
|
+
<h3 class="tsd-anchor-link" id="id"><code class="tsd-tag">Readonly</code><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
40
|
+
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
41
|
+
<ul>
|
|
42
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/flow.ts#L17">langgraph/flow.ts:17</a></li></ul></aside></section>
|
|
43
|
+
<section class="tsd-panel tsd-member">
|
|
44
|
+
<h3 class="tsd-anchor-link" id="logicalstate"><code class="tsd-tag">Readonly</code><span>logical<wbr/>State</span><a href="#logicalstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
45
|
+
<div class="tsd-signature"><span class="tsd-kind-property">logicalState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
46
|
+
<ul>
|
|
47
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/flow.ts#L18">langgraph/flow.ts:18</a></li></ul></aside></section>
|
|
48
|
+
<section class="tsd-panel tsd-member">
|
|
49
|
+
<h3 class="tsd-anchor-link" id="partitionkey"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>partition<wbr/>Key</span><a href="#partitionkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
50
|
+
<div class="tsd-signature"><span class="tsd-kind-property">partitionKey</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
51
|
+
<ul>
|
|
52
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/flow.ts#L19">langgraph/flow.ts:19</a></li></ul></aside></section>
|
|
53
|
+
<section class="tsd-panel tsd-member">
|
|
54
|
+
<h3 class="tsd-anchor-link" id="payload"><code class="tsd-tag">Readonly</code><span>payload</span><a href="#payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
55
|
+
<div class="tsd-signature"><span class="tsd-kind-property">payload</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
|
|
56
|
+
<ul>
|
|
57
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/flow.ts#L20">langgraph/flow.ts:20</a></li></ul></aside></section>
|
|
58
|
+
<section class="tsd-panel tsd-member">
|
|
59
|
+
<h3 class="tsd-anchor-link" id="state"><code class="tsd-tag">Readonly</code><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
60
|
+
<div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
61
|
+
<ul>
|
|
62
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/flow.ts#L21">langgraph/flow.ts:21</a></li></ul></aside></section>
|
|
63
|
+
<section class="tsd-panel tsd-member">
|
|
64
|
+
<h3 class="tsd-anchor-link" id="type"><code class="tsd-tag">Readonly</code><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
65
|
+
<div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
66
|
+
<ul>
|
|
67
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/flow.ts#L22">langgraph/flow.ts:22</a></li></ul></aside></section>
|
|
68
|
+
<section class="tsd-panel tsd-member">
|
|
69
|
+
<h3 class="tsd-anchor-link" id="values"><code class="tsd-tag">Readonly</code><span>values</span><a href="#values" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
70
|
+
<div class="tsd-signature"><span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
|
71
|
+
<ul>
|
|
72
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/flow.ts#L23">langgraph/flow.ts:23</a></li></ul></aside></section></section></details></div>
|
|
73
|
+
<div class="col-sidebar">
|
|
74
|
+
<div class="page-menu">
|
|
75
|
+
<div class="tsd-navigation settings">
|
|
76
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
77
|
+
<h3>Settings</h3></summary>
|
|
78
|
+
<div class="tsd-accordion-details">
|
|
79
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
80
|
+
<ul id="tsd-filter-options">
|
|
81
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
82
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
83
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
84
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
85
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
86
|
+
<h3>On This Page</h3></summary>
|
|
87
|
+
<div class="tsd-accordion-details">
|
|
88
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
89
|
+
<div><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#logicalstate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logical<wbr/>State</span></a><a href="#partitionkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>partition<wbr/>Key</span></a><a href="#payload"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>payload</span></a><a href="#state"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#values"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>values</span></a></div></details></div></details></div>
|
|
90
|
+
<div class="site-menu">
|
|
91
|
+
<nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
|
|
92
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
93
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
94
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FerricStoreCommandClient | @ferricstore/ferricstore</title><meta name="description" content="Documentation for @ferricstore/ferricstore"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@ferricstore/ferricstore</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="../modules/langgraph.html">langgraph</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">FerricStoreCommandClient</a></li></ul>
|
|
13
|
+
<h1>Interface FerricStoreCommandClient</h1></div>
|
|
14
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FerricStoreCommandClient</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#command-1">command</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandArgument</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#pipeline-1">pipeline</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">commands</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Command</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
15
|
+
<ul>
|
|
16
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/agent-persistence/durability.ts#L7">agent-persistence/durability.ts:7</a></li></ul></aside>
|
|
17
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
18
|
+
<section class="tsd-panel tsd-index-panel">
|
|
19
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
20
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
21
|
+
<div class="tsd-accordion-details">
|
|
22
|
+
<section class="tsd-index-section">
|
|
23
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
24
|
+
<div class="tsd-index-list"><a href="#command" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>command</span></a>
|
|
25
|
+
<a href="#pipeline" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pipeline?</span></a>
|
|
26
|
+
</div></section></div></details></section></section>
|
|
27
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
28
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
29
|
+
<section>
|
|
30
|
+
<section class="tsd-panel tsd-member">
|
|
31
|
+
<h3 class="tsd-anchor-link" id="command"><span>command</span><a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
32
|
+
<ul class="tsd-signatures">
|
|
33
|
+
<li class="">
|
|
34
|
+
<div class="tsd-signature tsd-anchor-link" id="command-1"><span class="tsd-kind-call-signature">command</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommandArgument</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span><a href="#command-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
35
|
+
<div class="tsd-description">
|
|
36
|
+
<div class="tsd-parameters">
|
|
37
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
38
|
+
<ul class="tsd-parameter-list">
|
|
39
|
+
<li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">CommandArgument</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
|
|
40
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
41
|
+
<ul>
|
|
42
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/agent-persistence/durability.ts#L8">agent-persistence/durability.ts:8</a></li></ul></aside></div></li></ul></section>
|
|
43
|
+
<section class="tsd-panel tsd-member">
|
|
44
|
+
<h3 class="tsd-anchor-link" id="pipeline"><code class="tsd-tag">Optional</code><span>pipeline</span><a href="#pipeline" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
45
|
+
<ul class="tsd-signatures">
|
|
46
|
+
<li class="">
|
|
47
|
+
<div class="tsd-signature tsd-anchor-link" id="pipeline-1"><span class="tsd-kind-call-signature">pipeline</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">commands</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Command</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#pipeline-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
48
|
+
<div class="tsd-description">
|
|
49
|
+
<div class="tsd-parameters">
|
|
50
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
51
|
+
<ul class="tsd-parameter-list">
|
|
52
|
+
<li><span><span class="tsd-kind-parameter">commands</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Command</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
|
|
53
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
54
|
+
<ul>
|
|
55
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/agent-persistence/durability.ts#L9">agent-persistence/durability.ts:9</a></li></ul></aside></div></li></ul></section></section></details></div>
|
|
56
|
+
<div class="col-sidebar">
|
|
57
|
+
<div class="page-menu">
|
|
58
|
+
<div class="tsd-navigation settings">
|
|
59
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
60
|
+
<h3>Settings</h3></summary>
|
|
61
|
+
<div class="tsd-accordion-details">
|
|
62
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
63
|
+
<ul id="tsd-filter-options">
|
|
64
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
65
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
66
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
67
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
68
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
69
|
+
<h3>On This Page</h3></summary>
|
|
70
|
+
<div class="tsd-accordion-details">
|
|
71
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
72
|
+
<div><a href="#command"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>command</span></a><a href="#pipeline"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pipeline</span></a></div></details></div></details></div>
|
|
73
|
+
<div class="site-menu">
|
|
74
|
+
<nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
|
|
75
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
76
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
77
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FerricStoreLockOptions | @ferricstore/ferricstore</title><meta name="description" content="Documentation for @ferricstore/ferricstore"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@ferricstore/ferricstore</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="../modules/langgraph.html">langgraph</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">FerricStoreLockOptions</a></li></ul>
|
|
13
|
+
<h1>Interface FerricStoreLockOptions</h1></div>
|
|
14
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">FerricStoreLockOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#lockretryms">lockRetryMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lockttlms">lockTtlMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lockwaitms">lockWaitMs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
|
|
15
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="450">
|
|
16
|
+
<h4>Hierarchy (<a href="../hierarchy.html#langgraph.FerricStoreLockOptions">View Summary</a>)</h4>
|
|
17
|
+
<ul class="tsd-hierarchy">
|
|
18
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FerricStoreLockOptions</span>
|
|
19
|
+
<ul class="tsd-hierarchy">
|
|
20
|
+
<li class="tsd-hierarchy-item"><a href="openai-agents.FerricStoreSessionOptions.html" class="tsd-signature-type tsd-kind-interface">FerricStoreSessionOptions</a></li>
|
|
21
|
+
<li class="tsd-hierarchy-item"><a href="langgraph.FerricStoreSaverOptions.html" class="tsd-signature-type tsd-kind-interface">FerricStoreSaverOptions</a></li>
|
|
22
|
+
<li class="tsd-hierarchy-item"><a href="langgraph.FerricStoreStoreOptions.html" class="tsd-signature-type tsd-kind-interface">FerricStoreStoreOptions</a></li></ul></li></ul></section><aside class="tsd-sources">
|
|
23
|
+
<ul>
|
|
24
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/agent-persistence/durability.ts#L12">agent-persistence/durability.ts:12</a></li></ul></aside>
|
|
25
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
26
|
+
<section class="tsd-panel tsd-index-panel">
|
|
27
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
28
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
29
|
+
<div class="tsd-accordion-details">
|
|
30
|
+
<section class="tsd-index-section">
|
|
31
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
32
|
+
<div class="tsd-index-list"><a href="#lockretryms" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Retry<wbr/>Ms?</span></a>
|
|
33
|
+
<a href="#lockttlms" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Ttl<wbr/>Ms?</span></a>
|
|
34
|
+
<a href="#lockwaitms" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Wait<wbr/>Ms?</span></a>
|
|
35
|
+
</div></section></div></details></section></section>
|
|
36
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
37
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
38
|
+
<section>
|
|
39
|
+
<section class="tsd-panel tsd-member">
|
|
40
|
+
<h3 class="tsd-anchor-link" id="lockretryms"><code class="tsd-tag">Optional</code><span>lock<wbr/>Retry<wbr/>Ms</span><a href="#lockretryms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
41
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lockRetryMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
42
|
+
<div class="tsd-comment tsd-typography"><p>Delay between lock acquisition attempts. Defaults to 10 milliseconds.</p>
|
|
43
|
+
</div><aside class="tsd-sources">
|
|
44
|
+
<ul>
|
|
45
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/agent-persistence/durability.ts#L18">agent-persistence/durability.ts:18</a></li></ul></aside></section>
|
|
46
|
+
<section class="tsd-panel tsd-member">
|
|
47
|
+
<h3 class="tsd-anchor-link" id="lockttlms"><code class="tsd-tag">Optional</code><span>lock<wbr/>Ttl<wbr/>Ms</span><a href="#lockttlms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
48
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lockTtlMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
49
|
+
<div class="tsd-comment tsd-typography"><p>Lease duration for adapter mutation locks. Defaults to five minutes.</p>
|
|
50
|
+
</div><aside class="tsd-sources">
|
|
51
|
+
<ul>
|
|
52
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/agent-persistence/durability.ts#L14">agent-persistence/durability.ts:14</a></li></ul></aside></section>
|
|
53
|
+
<section class="tsd-panel tsd-member">
|
|
54
|
+
<h3 class="tsd-anchor-link" id="lockwaitms"><code class="tsd-tag">Optional</code><span>lock<wbr/>Wait<wbr/>Ms</span><a href="#lockwaitms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
55
|
+
<div class="tsd-signature"><span class="tsd-kind-property">lockWaitMs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
56
|
+
<div class="tsd-comment tsd-typography"><p>Maximum time to wait for a contended mutation lock. Defaults to 30 seconds.</p>
|
|
57
|
+
</div><aside class="tsd-sources">
|
|
58
|
+
<ul>
|
|
59
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/agent-persistence/durability.ts#L16">agent-persistence/durability.ts:16</a></li></ul></aside></section></section></details></div>
|
|
60
|
+
<div class="col-sidebar">
|
|
61
|
+
<div class="page-menu">
|
|
62
|
+
<div class="tsd-navigation settings">
|
|
63
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
64
|
+
<h3>Settings</h3></summary>
|
|
65
|
+
<div class="tsd-accordion-details">
|
|
66
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
67
|
+
<ul id="tsd-filter-options">
|
|
68
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
69
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
70
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
71
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
72
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
73
|
+
<h3>On This Page</h3></summary>
|
|
74
|
+
<div class="tsd-accordion-details">
|
|
75
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
76
|
+
<div><a href="#lockretryms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Retry<wbr/>Ms</span></a><a href="#lockttlms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Ttl<wbr/>Ms</span></a><a href="#lockwaitms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Wait<wbr/>Ms</span></a></div></details></div></details></div>
|
|
77
|
+
<div class="site-menu">
|
|
78
|
+
<nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
|
|
79
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
80
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
81
|
+
<div class="overlay"></div></body></html>
|