KeplerFileSystem

Interface for the Kepler FileSystem TurboModule.

This is the interface contains basic methods to manipulate the contents of the local filesystem. It makes querying into the file system, traversing it, reading and writing to files possible.

Extends

• KeplerTurboModule

Properties

openFile

openFile: (path: string, mode: FileSystemTypes.OpenMode) => Promise<void>

Opens a file with the specified mode.

---

removeFile

removeFile: (path: string) => Promise<void>

Deletes a file at the path.

---

removeDir

removeDir: (path: string) => Promise<void>

Deletes a directory at the path.

---

removeDirAll

removeDirAll: (path: string) => Promise<void>

Deletes a directory at the path and all its content.

---

readFileAsString

readFileAsString: (path: string, encoding: string) => Promise<string>

Reads the entire content of a text file into a string.

---

writeStringToFile

writeStringToFile: (path: string, content: string, encoding: string) => Promise<number>

Writes a string to a text file.

---

getMetadata

getMetadata: (path: string, noFollow: boolean) => Promise<FileSystemTypes.Metadata>

Gets metadata about the file or symbolic link referred to by path.

---

getEntries

getEntries: (path: string) => Promise<string[]>

Gets directory entries for the given path.

---

exists

exists: (path: string) => Promise<boolean>

Checks if a file or directory exists at the given path.

---

Last updated: Jul 22, 2026