FileSystem

Properties

Property	Type	Description
`url`	`null` \| `URL`	A `URL` instance that points to the root of the filesystem mount. You should use this to create file path references within the filesystem mount. Example `const dataUrl = new URL('data.json', fileSystem.url);`

Methods

freeSpace()

freeSpace(): bigint

Returns

bigint

mount()

mount(name): URL

Mounts the FileSystem such that filesystem operations may be used.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the mount for filesystem paths. By default, a random name is generated. Should not exceed 31 characters, and should not have a trailing colon.

Returns

URL

totalSpace()

totalSpace(): bigint

Returns

bigint

openBis()

static openBis(id): FileSystem

Opens a file system partition specified by its BisPartitionId.

Parameters

Parameter	Type	Description
`id`	`number`	The `BisPartitionId` of the partition to open.

Returns

FileSystem

Example

import { BisPartitionId } from '@nx.js/constants';
 
// Open and mount the "User" partition
const fs = Switch.FileSystem.openBis(BisPartitionId.User);
const url = fs.mount();
 
// Read the file entries at the root of the partition
console.log(Switch.readDirSync(url));

openSdmc()

static openSdmc(): FileSystem

Opens a file system partition for the SD card.

Returns

FileSystem

Example

const fs = Switch.FileSystem.openSdmc();
console.log(fs.freeSpace());
console.log(fs.totalSpace());

FileSystem

On this page