useOptimistic

Hook that allows get optimistic value before its update

async

medium

test coverage

Last changed: 3 months ago

Installation

Library

CLI

Manual

import { useOptimistic } from '@siberiacancode/reactuse';

Usage

const [optimisticValue, updateOptimistic] = useOptimistic<number>(count, (currentState, optimisticValue) => currentState + optimisticValue);

Demo

source

Api

Parameters

Name	Type	Default	Note
state	State	-	The value to be returned initially and whenever no action is pending
update	(currentState: State, optimisticValue: State) => State	-	A pure function that takes the current state and the optimistic value passed to updateOptimistic and returns the resulting optimistic state

Returns

UseOptimisticReturn<State>

Type declaration

export type UseOptimisticReturn<State> = [
  State,
  (optimisticValue: State, promise: Promise<any>) => void
];

Source

Source • Demo

Contributors

D

debabin

M

Michael Mironychev