Skip to content

@mndw/sdk / @mndw/sdk/refresh

@mndw/sdk/refresh ​

Interfaces ​

RefreshLoop ​

Defined in: frontend/sdk/src/refresh.ts:9

Methods ​

setIntervalMs() ​

setIntervalMs(intervalMs): void

Defined in: frontend/sdk/src/refresh.ts:12

Parameters ​
intervalMs ​

number

Returns ​

void

start() ​

start(options?): void

Defined in: frontend/sdk/src/refresh.ts:10

Parameters ​
options? ​
immediate? ​

boolean

Returns ​

void

stop() ​

stop(): void

Defined in: frontend/sdk/src/refresh.ts:11

Returns ​

void


RefreshLoopOptions ​

Defined in: frontend/sdk/src/refresh.ts:2

Type Parameters ​

T ​

T

Properties ​

intervalMs ​

intervalMs: number

Defined in: frontend/sdk/src/refresh.ts:4

Methods ​

load() ​

load(): Promise<T>

Defined in: frontend/sdk/src/refresh.ts:3

Returns ​

Promise<T>

onError() ​

onError(error, isInitial): void

Defined in: frontend/sdk/src/refresh.ts:6

Parameters ​
error ​

unknown

isInitial ​

boolean

Returns ​

void

onSuccess() ​

onSuccess(value): void

Defined in: frontend/sdk/src/refresh.ts:5

Parameters ​
value ​

T

Returns ​

void

Functions ​

createRefreshLoop() ​

createRefreshLoop<T>(options): RefreshLoop

Defined in: frontend/sdk/src/refresh.ts:15

Type Parameters ​

T ​

T

Parameters ​

options ​

RefreshLoopOptions<T>

Returns ​

RefreshLoop

Built from the mndw repository documentation.