Class SaveSyncClient

Hierarchy

HttpTransport
- SaveSyncClient

Index

Constructors

Properties

endpoint fetchFn timeoutMs

Methods

download list upload withTimeout

Constructors

constructor

new SaveSyncClient(options: HttpTransportOptions): SaveSyncClient
Parameters
- options: HttpTransportOptions
Returns SaveSyncClient
Overrides HttpTransport.constructor
- Defined in src/core/SaveSync.ts:37

Properties

`Protected` `Readonly`endpoint

endpoint: string

`Protected` `Readonly`fetchFn

fetchFn: {
(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
(input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Type Declaration

- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
- MDN Reference
  Parameters
  - input: URL | RequestInfo
  - Optionalinit: RequestInit
  Returns Promise<Response>
- (input: string | URL | Request, init?: RequestInit): Promise<Response>
- MDN Reference
  Parameters
  - input: string | URL | Request
  - Optionalinit: RequestInit
  Returns Promise<Response>

`Protected` `Readonly`timeoutMs

timeoutMs: number

Methods

download

download(slot: string): Promise<string>
fetches whatever payload the endpoint currently holds for slot, ready for SaveSystem.importSlot
Parameters
- slot: string
Returns Promise<string>
- Defined in src/core/SaveSync.ts:58

list

list(): Promise<string[]>
every slot name this endpoint currently holds for this player, for a profile picker to list

Returns Promise<string[]>
- Defined in src/core/SaveSync.ts:70

upload

upload(slot: string, payload: string): Promise<SaveSyncResponse>
sends an exportSlot payload for slot to the endpoint, replacing whatever it held before
Parameters
- slot: string
- payload: string
Returns Promise<SaveSyncResponse>
- Defined in src/core/SaveSync.ts:42

`Protected`withTimeout

withTimeout<T>(run: (signal: AbortSignal) => Promise<T>): Promise<T>
Type Parameters
- T
Parameters
- run: (signal: AbortSignal) => Promise<T>
Returns Promise<T>
Inherited from HttpTransport.withTimeout
- Defined in src/core/HttpTransport.ts:30