SaveData

Represents a "save data store".

Properties

Property	Modifier	Type	Description
`applicationId`	`readonly`	`bigint`	-
`id`	`readonly`	`bigint`	-
`index`	`readonly`	`number`	-
`rank`	`readonly`	`number`	-
`size`	`readonly`	`bigint`	-
`spaceId`	`readonly`	`number`	-
`systemId`	`readonly`	`bigint`	-
`type`	`readonly`	`number`	-
`uid`	`readonly`	`ProfileUid`	-
`url`	`public`	`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', saveData.url);`

Methods

commit()

commit(): void

Commits to the disk any write operations that have occurred on this filesystem mount since the previous commit.

Failure to call this function after writes will cause the data to be lost after the application exits.

Returns

void

Example

const saveStateUrl = new URL('state', saveData.url);
Switch.writeFileSync(saveStateUrl, 'my application state...');
 
saveData.commit(); // Write operation is persisted to the disk

delete()

delete(): void

Deletes the save data store.

Returns

void

Warn

This is a destructive operation! Use caution when using this function to avoid accidental data loss.

extend()

extend(dataSize, journalSize): void

Grows a save data store to the requested dataSize and journalSize.

Parameters

Parameter	Type	Description
`dataSize`	`bigint`
`journalSize`	`bigint`

Returns

void

freeSpace()

freeSpace(): bigint

Returns

bigint

mount()

mount(name): URL

Mounts the save data 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. Shouldn't exceed 31 characters, and shouldn't have a trailing colon.

Returns

URL

totalSpace()

totalSpace(): bigint

Returns

bigint

unmount()

unmount(): void

Unmounts the filesystem mount. Any filesytem operations attempting to use the mount path in the future will throw an error.

Returns

void

Example

Switch.readDirSync(saveData.url); // OK
 
saveData.unmount();
 
Switch.readDirSync(saveData.url); // ERROR THROWN!

[iterator]()

static [iterator](): Generator<SaveData, void, unknown>

Returns

Generator<SaveData, void, unknown>

createSync()

createSync(init)

static createSync(init): SaveData

Parameters

Parameter	Type
`init`	`SaveDataCreationInfoBase`

Returns

SaveData

createSync(init, nacp)

static createSync(init, nacp): SaveData

Parameters

Parameter	Type
`init`	`SaveDataCreationInfoWithNacp`
`nacp`	`ArrayBuffer`

Returns

SaveData

filter()

static filter(filter): Generator<SaveData, void, unknown>

Parameters

Parameter	Type
`filter`	`SaveDataFilter`

Returns

Generator<SaveData, void, unknown>

find()

static find(filter): undefined | SaveData

Parameters

Parameter	Type
`filter`	`SaveDataFilter`

Returns

undefined | SaveData

SaveData

On this page