Home Reference Source
import {StorageInterface} from 'shapez.io/js/platform/storage.js'
public class | source

StorageInterface

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

Method Summary

Public Methods
public

deleteFileAsync(filename: string): Promise<void>

Tries to delete a file

public

initialize(): Promise<void>

Initializes the storage

public

Reads a string asynchronously.

public

writeFileAsync(filename: string, contents: string): Promise<void>

Writes a string to a file asynchronously

public

Tries to write a file synchronously, used in unload handler

Public Constructors

public constructor() source

Public Members

public app: Application source

Public Methods

public deleteFileAsync(filename: string): Promise<void> source

Tries to delete a file

Params:

NameTypeAttributeDescription
filename string

Return:

Promise<void>

public initialize(): Promise<void> source

Initializes the storage

Return:

Promise<void>

public readFileAsync(filename: string): Promise<string> source

Reads a string asynchronously. Returns Promise<FILE_NOT_FOUND> if file was not found.

Params:

NameTypeAttributeDescription
filename string

Return:

Promise<string>

public writeFileAsync(filename: string, contents: string): Promise<void> source

Writes a string to a file asynchronously

Params:

NameTypeAttributeDescription
filename string
contents string

Return:

Promise<void>

public writeFileSyncIfSupported(filename: string, contents: string): boolean source

Tries to write a file synchronously, used in unload handler

Params:

NameTypeAttributeDescription
filename string
contents string

Return:

boolean