Skip to content

Interface: FsToolEffectAttributes ​

Defined in: fs/src/executors/fs-tool-effect.ts:10

Structured filesystem attributes attached to an FsToolEffect descriptor.

Captures the access mode ('read' | 'write'), canonicalized worktree-relative POSIX file paths, base-ref path existence (existingPathsAtBaseRef), and post-edit UTF-8 contents (proposedContent).

Extends ​

  • Readonly<Record<string, unknown>>

Indexable ​

ts
[key: string]: unknown

Properties ​

PropertyModifierTypeDescriptionDefined in
existingPathsAtBaseRef?readonlyreadonly string[]Subset of paths that already existed at scopeHandle.baseRef prior to mutation.fs/src/executors/fs-tool-effect.ts:16
modereadonly"read" | "write"Filesystem access mode ('read' for non-mutating reads/searches, 'write' for edits/writes).fs/src/executors/fs-tool-effect.ts:12
pathsreadonlyreadonly string[]Canonicalized worktree-relative POSIX file paths touched by the tool invocation.fs/src/executors/fs-tool-effect.ts:14
proposedContent?readonlyReadonly<Record<string, string>>Proposed post-mutation UTF-8 file text keyed by normalized worktree-relative path.fs/src/executors/fs-tool-effect.ts:18

Released under the MIT License.