FluxFlow.Components.FileSystem 0.4.2-alpha.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of FluxFlow.Components.FileSystem.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package FluxFlow.Components.FileSystem --version 0.4.2-alpha.1
                    


                    

                
NuGet\Install-Package FluxFlow.Components.FileSystem -Version 0.4.2-alpha.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="FluxFlow.Components.FileSystem" Version="0.4.2-alpha.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="FluxFlow.Components.FileSystem" Version="0.4.2-alpha.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="FluxFlow.Components.FileSystem" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add FluxFlow.Components.FileSystem --version 0.4.2-alpha.1
                    


                    

                
#r "nuget: FluxFlow.Components.FileSystem, 0.4.2-alpha.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package FluxFlow.Components.FileSystem@0.4.2-alpha.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=FluxFlow.Components.FileSystem&version=0.4.2-alpha.1&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=FluxFlow.Components.FileSystem&version=0.4.2-alpha.1&prerelease
                    


                            Install as a Cake Tool

FluxFlow.Components.FileSystem

Reusable file system components for FluxFlow.

Nodes

Node type Shape Purpose
directory.enumerate Output Emits files and directories from a configured directory.
file.read Input → Result Reads file content as text or bytes and emits a read result.
file.watch Output Emits file system change events from a watched directory.
file.write Input → Result Writes request content to a file and emits a write result.

Failures emit FlowError through the node error stream and do not stop later messages from being processed.

Write Request

new FileWriteRequest
{
    Path = "logs/output.txt",
    Content = "hello",
    Mode = FileWriteMode.Overwrite,
    CreateDirectories = true
}

Bytes can be used instead of Content. When both are set, Bytes wins.

Read Request

new FileReadRequest
{
    Path = "logs/output.txt",
    ReadAs = FileReadMode.Text
}

Use ReadAs = FileReadMode.Bytes when the workflow needs raw bytes. Text reads use the request Encoding value when provided, otherwise defaultEncoding.

Watch Output

{
  "type": "file.watch",
  "directory": "inbox",
  "filter": "*.json",
  "includeSubdirectories": false,
  "notifyFilters": [ "FileName", "LastWrite", "Size" ],
  "baseDirectory": "data",
  "allowAbsolutePaths": false,
  "boundedCapacity": 128
}

file.watch emits FileWatchEvent values with the changed path, directory, name, change type, and old path/name for rename events.

Directory Enumerate Output

{
  "type": "directory.enumerate",
  "directory": "inbox",
  "filter": "*.json",
  "includeSubdirectories": true,
  "includeFiles": true,
  "includeDirectories": false,
  "maxEntries": 1000,
  "baseDirectory": "data",
  "allowAbsolutePaths": false,
  "boundedCapacity": 128
}

directory.enumerate emits DirectoryEnumerateEntry values with the resolved path, source directory, name, entry type, optional byte length, timestamps, and file attributes.

Configuration

{
  "type": "file.read",
  "baseDirectory": "data",
  "allowAbsolutePaths": false,
  "defaultEncoding": "utf-8",
  "maxBytes": 1048576,
  "boundedCapacity": 128
}

Relative paths are resolved under baseDirectory when it is set. Relative paths that escape the base directory are rejected. Absolute paths are rejected unless allowAbsolutePaths is true.

Supported write modes:

  • Overwrite
  • Append
  • CreateNew

Supported read modes:

  • Text
  • Bytes

Composition Guidance

Use this package as one part of a host-composed graph. See Component Composition for recommended host boundaries, package boundaries, and extraction timing.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0 6 6/5/2026
1.0.0 43 6/4/2026
0.5.0-alpha.1 91 6/2/2026
0.4.2-alpha.1 48 6/2/2026
0.4.1-alpha.1 45 6/2/2026
0.4.0-alpha.1 96 6/1/2026
0.3.0-alpha.1 44 6/1/2026
0.2.0-alpha.1 44 6/1/2026
0.1.0-alpha.1 62 6/1/2026

Ensures directory.enumerate emits its started diagnostic before enumeration work begins.