Filesystem

The board's own files — Read one (whole, or a slice at a time), Write or add to one, Copy, Move, Delete, check a path (Info) and List a folder.

The board's own files — Read one (whole, or a slice at a time), Write or add to one, Copy, Move, Delete, check a path (Info) and List a folder. What a Request saved, data to keep between runs, a log.

@henglosio/component-filesystemv1.0.0platform ^1.0.0

Node	Kind	What it does
Read	Action	A file's text — all of it when it fits a value (384 bytes), else a slice: Offset and Length pick which, `end` says whether it's the last.
Write	Action	Puts Content in a file — over what was there, or added at its end (Mode).
Copy	Action	A file to another path — its folders made, over what was there.
Move	Action	Renames a file or folder, or moves it elsewhere (the destination's folders are made).
Delete	Action	Removes a file, or a folder — an empty one, or everything in it with Recursive.
Info	Action	Branches on whether a path is there — Exists or Missing — with whether it's a folder and its size.
List	Action	What's in a folder — each entry's name, size and whether it's a folder, sorted by name, as many as fit a value (`count` says how many there are).

Actions

Read

A file's text — all of it when it fits a value (384 bytes), else a slice: Offset and Length pick which, end says whether it's the last. Fallback when it isn't there or is a folder.

Settings

Setting	Type	Default	What it's for
File	Text	—	Required. The file's path — /data/log.txt; bind a Request's `file` to read its answer.
Offset	Number (from 0)	`0`	Advanced. Where to start, in bytes — 0 is the beginning. The next slice starts at Offset + `read`.
Length	Number (from 0)	`0`	Advanced. How many bytes to read — 0 (or more than fits) reads as much as fits a value, 384.

Publishes

Output	Type	What it is
`content`	str	The text read — a character cut at the slice's end is left for the next one.
`size`	int	The whole file's size, in bytes.
`read`	int	How many bytes this read took — the next Offset is Offset + read.
`end`	bool	Whether this slice reached the end of the file.
`error`	str	Why it's Fallback — no_file, is_folder, denied, no_path, failed: …; empty otherwise.

Write

Puts Content in a file — over what was there, or added at its end (Mode). Its folders are made. Fallback for a path the board relies on.

Settings

Setting	Type	Default	What it's for
File	Text	—	Required. The file to write — /data/log.txt; its folders are made.
Content	Text	—	What to write — text, or bind an output (a Code binding can build it).
Mode	One of: Overwrite, Append	Overwrite	Overwrite replaces what the file had; Append adds at its end (a log).

Publishes

Output	Type	What it is
`file`	str	The file's path.
`size`	int	The file's size after writing, in bytes.
`error`	str	Why it's Fallback — no_file, is_folder, denied, no_path, failed: …; empty otherwise.

Copy

A file to another path — its folders made, over what was there. Keeps a Request's temporary answer for good. Fallback when the source isn't a file.

Settings

Setting	Type	Default	What it's for
From	Text	—	Required. The file to copy — bind a Request's `file`, or a path.
To	Text	—	Required. Where it goes — its folders are made.

Publishes

Output	Type	What it is
`file`	str	The copy's path.
`size`	int	The copy's size, in bytes.
`error`	str	Why it's Fallback — no_file, is_folder, denied, no_path, failed: …; empty otherwise.

Move

Renames a file or folder, or moves it elsewhere (the destination's folders are made). Fallback when there's nothing to move or something's already at To.

Settings

Setting	Type	Default	What it's for
From	Text	—	Required. The file or folder to move.
To	Text	—	Required. Its new path — nothing may be there yet; its folders are made.

Publishes

Output	Type	What it is
`file`	str	The new path.
`error`	str	Why it's Fallback — no_file, is_folder, denied, no_path, failed: …; empty otherwise.

Delete

Removes a file, or a folder — an empty one, or everything in it with Recursive. Fallback when nothing's there or the folder isn't empty.

Settings

Setting	Type	Default	What it's for
Path	Text	—	Required. The file or folder to remove.
Recursive	On / off	Off	Advanced. A folder goes with everything in it — off, only an empty one.

Publishes

Output	Type	What it is
`error`	str	Why it's Fallback — no_file, is_folder, denied, no_path, failed: …; empty otherwise.

Info

Branches on whether a path is there — Exists or Missing — with whether it's a folder and its size.

Ends on Exists, Missing — or Fallback when it can't run.

Settings

Setting	Type	Default	What it's for
Path	Text	—	Required. The file or folder to check.

Publishes

Output	Type	What it is
`exists`	bool	Whether something's there.
`folder`	bool	Whether it's a folder.
`size`	int	A file's size, in bytes — 0 for a folder or nothing.

List

What's in a folder — each entry's name, size and whether it's a folder, sorted by name, as many as fit a value (count says how many there are).

Settings

Setting	Type	Default	What it's for
Folder	Text	`/`	The folder to list — / is the board's root.

Publishes

Output	Type	What it is
`entries`	list of { name: str, size: int, folder: bool }	The entries, sorted by name — bind it to a List variable.
`count`	int	How many entries the folder has — more than `entries` when they don't all fit.
`error`	str	Why it's Fallback — no_folder, denied, failed: …; empty otherwise.

ActionsCopy Anchor Link

ReadCopy Anchor Link

WriteCopy Anchor Link

CopyCopy Anchor Link

MoveCopy Anchor Link

DeleteCopy Anchor Link

InfoCopy Anchor Link

ListCopy Anchor Link

On this page

Actions

Read

Write

Copy

Move

Delete

Info

List