Interface ICachedDataComponentProps<T>

interface ICachedDataComponentProps<T> {
    dataKey?: string;
    children?: ((data: T, component: CachedDataComponent<T, ICachedDataComponentProps<T>>) => Element);
    load?: ((component: CachedDataComponent<T, ICachedDataComponentProps<T>>) => Promise<T>);
    LoaderComponent?: ReactNode;
    onData?: ((data: T) => void);
    onError?: ((error: any) => void);
    refresh?: boolean;
    renderError?: ((error: any) => Element);
    transformData?: ((data: T) => T);
    update?: ((data: T) => Promise<T>);
}

Type Parameters

  • T

Hierarchy

Properties

dataKey? children? load? LoaderComponent? onData? onError? refresh? renderError? transformData? update?

Properties

OptionaldataKey

dataKey?: string

The key with which are the data stored in the store. The property is required if the component is not inherited.

Optionalchildren

children?: ((data: T, component: CachedDataComponent<T, ICachedDataComponentProps<T>>) => Element)

Function as children for rendering the data. The property is required if the data component is not inherited.

Optionalload

load?: ((component: CachedDataComponent<T, ICachedDataComponentProps<T>>) => Promise<T>)

Function to load the data. The property is required if the data component is not inherited.

OptionalLoaderComponent

LoaderComponent?: ReactNode

The component to render while the data are loading.

OptionalonData

onData?: ((data: T) => void)

Function called when the data are received.

OptionalonError

onError?: ((error: any) => void)

Function called if the error occurs during the request.

Optionalrefresh

refresh?: boolean

Indicates if the component should force load the data on mount.

OptionalrenderError

renderError?: ((error: any) => Element)

Function for rendering the error.

OptionaltransformData

transformData?: ((data: T) => T)

Transforms the data before storing.

Optionalupdate

update?: ((data: T) => Promise<T>)

Function to updated data in the store. The property is required if the data component is not inherited.

Settings

Member Visibility

On This Page

Properties