fs

fs

Field	Value
Prefix	fs
Namespace constant	FsNamespace
Subjects constant	FsSubjects
Kind	bus
Schema record	FsSchemas
Tier	framework
Package	@makaio/services-core
Defined in	packages/services/core/src/filesystem/namespace.ts

Subjects

Key	Wire	Type	Schema
batch	fs.batch	event	schemas.ts
changed	fs.changed	event	schemas.ts
getHomeDir	fs.getHomeDir	rpc	—
glob	fs.glob	rpc	—
listDirectory	fs.listDirectory	rpc	—
listSources	fs.listSources	rpc	—
readFile	fs.readFile	rpc	—
unwatch	fs.unwatch	rpc	—
watch	fs.watch	rpc	—
writeFile	fs.writeFile	rpc	—

Subject Details

fs.batch (event)

Batch file change event payload.

Subject: fs.batch Type: Event

Field	Type	Required
changes	{ path: string; kind: "create" | "delete" | "change"; }[]	yes

fs.changed (event)

Single file change event payload.

Subject: fs.changed Type: Event

Field	Type	Required
kind	"create" | "delete" | "change"	yes
path	string	yes

fs.getHomeDir (rpc)

Subject: fs.getHomeDir Type: Request (RPC)

Request:

Field	Type	Required
machineId	string	yes

Response:

Field	Type	Required
path	string	yes

fs.glob (rpc)

Subject: fs.glob Type: Request (RPC)

Request:

Field	Type	Required
cwd	string	yes
ignore	string[] | undefined	no
limit	number | undefined	no
machineId	string | undefined	no
offset	number | undefined	no
pattern	string	yes

Response:

Field	Type	Required
files	{ path: string; relativePath: string; type: "file" | "directory"; size?: number | undefined; }[]	yes
total	number	yes
truncated	boolean	yes

fs.listDirectory (rpc)

Subject: fs.listDirectory Type: Request (RPC)

Request:

Field	Type	Required
machineId	string	yes
options	{ includeHidden: boolean; excludeNames?: string[] | undefined; } | undefined	no
path	string | undefined	no

Response:

Field	Type	Required
breadcrumbs	{ name: string; path: string; }[]	yes
entries	{ name: string; path: string; type: "file" | "directory"; relativePath?: string | undefined; isGitRepo?: boolean | undefined; size?: number | undefined; modified?: number | undefined; }[]	yes
errors	{ name: string; code: string; message: string; }[] | undefined	no
isGitRepo	boolean	yes
parentPath	string | null	yes
path	string	yes
segments	string[]	yes

fs.listSources (rpc)

Subject: fs.listSources Type: Request (RPC)

Request:

Empty object.

Response:

Field	Type	Required
sources	{ machineId: string; label: string; }[]	yes

fs.readFile (rpc)

Subject: fs.readFile Type: Request (RPC)

Request:

Field	Type	Required
encoding	string	yes
machineId	string | undefined	no
path	string	yes

Response:

Field	Type	Required
content	string	yes

fs.unwatch (rpc)

Subject: fs.unwatch Type: Request (RPC)

Request:

Field	Type	Required
id	string	yes

Response:

Field	Type	Required
success	boolean	yes

fs.watch (rpc)

Subject: fs.watch Type: Request (RPC)

Request:

Field	Type	Required
excludeFromDefaults	string[] | undefined	no
extensions	string[] | undefined	no
id	string	yes
paths	string[]	yes

Response:

Field	Type	Required
success	boolean	yes
watchId	string	yes

fs.writeFile (rpc)

Subject: fs.writeFile Type: Request (RPC)

Request:

Field	Type	Required
content	string	yes
encoding	string	yes
machineId	string | undefined	no
path	string	yes

Response:

Field	Type	Required
success	boolean	yes

---

Auto-generated by yarn docs:bus. Do not edit manually.