Class SaveData

ReadonlyapplicationId

Readonlyid

Readonlyindex

Readonlyrank

Readonlysize

ReadonlyspaceId

ReadonlysystemId

Readonlytype

Readonlyuid

url

const dataUrl = new URL('data.json', saveData.url);
Copy

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
  Copy

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

  • 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

  • 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!
  Copy

Static[iterator]

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

• Returns Generator<SaveData, void, unknown>

StaticcreateSync

• createSync(init): SaveData

• Parameters

  • init: SaveDataCreationInfoBase

  Returns SaveData

• createSync(init, nacp): SaveData

• Parameters

  • init: SaveDataCreationInfoWithNacp
  • nacp: ArrayBuffer

  Returns SaveData

Staticfilter

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

• Parameters

  • filter: SaveDataFilter

  Returns Generator<SaveData, void, unknown>

Staticfind

• find(filter): undefined | SaveData

• Parameters

  • filter: SaveDataFilter

  Returns undefined | SaveData