Interface Blok<TData>

Type parameters

TData = any

Hierarchy

Blok

Index

Properties

Methods

Properties

data

data: TData

get current data of the blok

Readonly error

error: any

Readonly loading

loading: boolean

Readonly merge

merge: TData extends {} ? (data: UpdateData<Partial<TData>>, mode?: ConcurrentMode) => Blok<TData> : never

Methods

action

action<TParams>(updater: Updater<TData, TParams>, mode?: ConcurrentMode): (...args: TParams) => void

- Defined in packages/reblok/lib/types.ts:143
create an action that call specified reducer when invoking

Type parameters
- TParams: any[]
Parameters
- updater: Updater<TData, TParams>
- Optional mode: ConcurrentMode
Returns (...args: TParams) => void
- - (...args: TParams): void
  - create an action that call specified reducer when invoking
    
    Parameters
    - Rest ...args: TParams
    Returns void

clearError

clearError(): void

- Defined in packages/reblok/lib/types.ts:137
Returns void

debounce

debounce(ms: number, data: UpdateData<TData>): void

- Defined in packages/reblok/lib/types.ts:92
Parameters
- ms: number
- data: UpdateData<TData>
Returns void

dispose

dispose(): void

- Defined in packages/reblok/lib/types.ts:148
Returns void

get

get(): TData
get<TPath>(path: TPath): PathValue<TData, TPath>

- Defined in packages/reblok/lib/types.ts:99
get current data of the blok

Returns TData
- Defined in packages/reblok/lib/types.ts:100
Type parameters
- TPath: string
Parameters
- path: TPath
Returns PathValue<TData, TPath>

listen

listen(listener: VoidFunction): VoidFunction

- Defined in packages/reblok/lib/types.ts:65
Parameters
- listener: VoidFunction
Returns VoidFunction

local

local(): Blok<TData>
local(data: UpdateData<TData>): Blok<TData>

- Defined in packages/reblok/lib/types.ts:112
create a local instance of the blok Note: this is React hook so you must follow hook rules to use this: https://reactjs.org/docs/hooks-rules.html

Returns Blok<TData>
- Defined in packages/reblok/lib/types.ts:117
create a local instance of the blok

Parameters
- data: UpdateData<TData>
Returns Blok<TData>

mset

mset<TKey, TValues>(values: TValues, mode?: ConcurrentMode): Blok<TData>

- Defined in packages/reblok/lib/types.ts:80
Type parameters
- TKey: string
- TValues: { [ key in string]?: UpdateData<PathValue<TData, key>> }
Parameters
- values: TValues
- Optional mode: ConcurrentMode
Returns Blok<TData>

reset

reset(): void

- Defined in packages/reblok/lib/types.ts:135
reset blok data to initial data

Returns void

set

set(data: UpdateData<TData>, mode?: ConcurrentMode): Blok<TData>
set<TPath>(path: TPath, data: UpdateData<PathValue<TData, TPath>>, mode?: ConcurrentMode): Blok<TData>

- Defined in packages/reblok/lib/types.ts:72
Parameters
- data: UpdateData<TData>
- Optional mode: ConcurrentMode
Returns Blok<TData>
- Defined in packages/reblok/lib/types.ts:74
Type parameters
- TPath: string
Parameters
- path: TPath
- data: UpdateData<PathValue<TData, TPath>>
- Optional mode: ConcurrentMode
Returns Blok<TData>

throttle

throttle(ms: number, data: UpdateData<TData>): void

- Defined in packages/reblok/lib/types.ts:94
Parameters
- ms: number
- data: UpdateData<TData>
Returns void

use

use(): TData
use<R>(selector: (blok: Blok<TData>) => R, compare?: Comparer<R>): R
use(defaultValue: TData): TData

- Defined in packages/reblok/lib/types.ts:107
bind the blok to the React component and return the blok data Note: this is React hook so you must follow hook rules to use this: https://reactjs.org/docs/hooks-rules.html

Returns TData
- Defined in packages/reblok/lib/types.ts:124
bind the blok to the React component and return selected slice of the blok data. Note: this is React hook so you must follow hook rules to use this: https://reactjs.org/docs/hooks-rules.html

Type parameters
- R
Parameters
- selector: (blok: Blok<TData>) => R
  - - (blok: Blok<TData>): R
    - Parameters
      - blok: Blok<TData>
      Returns R
- Optional compare: Comparer<R>
Returns R
- Defined in packages/reblok/lib/types.ts:126
Parameters
- defaultValue: TData
Returns TData

wait

wait(): Promise<TData>

- Defined in packages/reblok/lib/types.ts:130
wait until blok data is ready or blok has an error

Returns Promise<TData>

Generated using TypeDoc