Class SaveData

constructor

• new SaveData(spaceId, id): SaveData

• Creates a new SaveData instance with manually provided values.

  Parameters

  • spaceId: number

  • id: bigint

  Returns SaveData

  Note

  This does not create new save data - the values should represent an existing save data.

• new SaveData(spaceId, filter): SaveData

• Parameters

  • spaceId: number

  • filter: SaveDataFilter

  Returns SaveData

Readonly applicationId

Readonly id

Readonly index

Readonly rank

Readonly size

Readonly spaceId

Readonly systemId

Readonly type

Readonly uid

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

• Returns void

extend

• extend(dataSize, journalSize): void

• Parameters

  • dataSize: bigint

  • journalSize: bigint

  Returns void

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

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.readFileSync(device.url); // OK
  
  device.unmount();
  
  Switch.readFileSync(device.url); // ERROR THROWN!
  Copy

Static [iterator]

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

• Returns Generator<SaveData, void, unknown>

Static createSync

• createSync(spaceId, init): SaveData

• Parameters

  • spaceId: number

  • init: SaveDataInit

  Returns SaveData