PersistentAI API Documentation / @persistentai/fireflow-vfs / path
path
VFS Path Module
Provides safe, immutable path and URI handling for the VFS system.
Example
typescript
import { VfsPath, VfsUri, buildUri, basename } from '@persistentai/fireflow-vfs/path'
// Using VfsPath class
const path = VfsPath.parse('/foo/bar.txt')
path.name // 'bar.txt'
path.parent() // VfsPath('/foo')
// Using VfsUri class
const uri = VfsUri.fromPath('/foo/bar.txt')
uri.toString() // 'ff:///foo/bar.txt'
// Using utility functions
basename('/foo/bar.txt') // 'bar.txt'
buildUri('/foo/bar') // 'ff:///foo/bar'Interfaces
Type Aliases
Variables
- ALL_RESERVED_NAMES
- DOUBLE_SLASH_PATTERN
- EXTENSION_SEPARATOR
- FLOW_PACKAGE
- INVALID_FILENAME_CHARS
- INVALID_PATH_SEGMENT_CHARS
- MARKER_FILENAMES
- MAX_FILENAME_LENGTH
- MAX_PATH_DEPTH
- MAX_PATH_LENGTH
- PATH_SEPARATOR
- PATH_TRAVERSAL_PATTERN
- RESERVED_FILENAMES
- VFS_SCHEME
- VFS_SCHEME_PREFIX
- VFS_URI_REGEX
Functions
- assertValidFilename
- assertValidPath
- assertValidUri
- dirname
- ensureTrailingSlash
- extname
- extractPath
- flowDataPath
- flowEventFilePath
- flowEventsDir
- flowEventsKeepPath
- flowKeepPath
- flowManifestPath
- getPathDepth
- getPathSegments
- isAbsolute
- isChildPath
- isDirectory
- isEventFile
- isFlowPackage
- isVfsUri
- isVfsUriInstance
- joinPath
- relativePath
- removeTrailingSlash
- resolveFlowDataPath
- resolveFlowManifestPath
- stem
- toVfsPath
- toVfsUri
- validateFilename
- validatePath
- validateUri
- withExtension
- withName
References
basename
Re-exports basename
buildUri
Re-exports buildUri
normalizePath
Re-exports normalizePath
toLakeFSPath
Re-exports toLakeFSPath
VfsPath
Re-exports VfsPath
VfsUri
Re-exports VfsUri