LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Agent
  • Middleware
  • Backends
  • Sandboxes
  • Skills
  • Subagents
  • Types
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
  • Vitest
⌘I

Chat LangChain

What can I help with?

Enter to send·Shift+Enter new line

Menu

OverviewAgentMiddlewareBackendsSandboxesSkillsSubagentsTypes
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
Vitest
Language
Theme
JavaScriptdeepagentsbackendsWriteResult
Interface●Since v1.6

WriteResult

Result from backend write operations.

Checkpoint backends populate filesUpdate with {file_path: file_data} for LangGraph state. External backends set filesUpdate to null (already persisted to disk/S3/database/etc).

Copy
interface WriteResult

Properties

property
error: string

Error message on failure, undefined on success

property
metadata: Record<string, unknown>

Metadata for the write operation, attached to the ToolMessage

property
path: string

File path of written file, undefined on failure

deprecatedproperty
filesUpdate: Record<string, FileData> | null

State update dict for checkpoint backends, null for external storage. Checkpoint backends populate this with {file_path: file_data} for LangGraph state. External backends set null (already persisted to disk/S3/database/etc).

View source on GitHub