Filesystem
Core ships with a filesystem abstraction that makes it easy to switch from a local filesystem to a remote one. The default driver that is shipped provides access to the local filesystem but using your own filesystem driver is just as easy.
Prerequisites
Before we start, we need to establish what a few recurring variables and imports in this document refer to when they are used.
import { app, Container, Services } from "@arkecosystem/core-kernel";
- The
appimport refers to the application instance which grants access to the container, configurations, system information and more. - The
Containerimport refers to a namespace that contains all of the container specific entities like binding symbols and interfaces. - The
Servicesimport refers to a namespace that contains all of the core services. This generally will only be needed for type hints as Core is responsible for service creation and maintenance.
Filesystem Usage
Determine if a file exists
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.exists("/home/ark/stats.txt");
Get the contents of a file
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.get("/home/ark/stats.txt");
Write the contents of a file
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.put("/home/ark/stats.txt", "Hello World");
Delete the file at a given path
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.delete("/home/ark/stats.txt");
Copy a file to a new location
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.copy("/home/ark/old.txt", "/home/ark/new.txt");
Move a file to a new location
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.move("/home/ark/old.txt", "/home/ark/new.txt");
Get the file size of a given file
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.size("/home/ark/stats.txt");
Get the file’s last modification time
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.lastModified("/home/ark/stats.txt");
Get an array of all files in a directory
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.files("/home/ark");
Get all of the directories within a given directory
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.directories("/home/ark");
Create a directory
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.makeDirectory("/home/ark");
Recursively delete a directory
app
.get<Services.Filesystem.FilesystemService>(Container.Identifiers.FilesystemService)
.deleteDirectory("/home/ark");
Extending
@TODO
Last updated 1 month ago
Edit Page