The response: {JSON.stringify(submitResult.value)}
}\n
;\n};\n```\n\n## Demos\n\n- [API Example](https://react-async-stateful.netlify.com/api)\n\n## useAsyncState hook\n\nThe `useAsyncState` hook returns:\n\n```jsx harmony\n const [asyncState, setAsyncState, updateAsyncState] = useAsyncState(defaultValue);\n``` \n\n- `asyncState` is the the current value of the async state\n- `setAsyncState` is usually never needed but can be useful to synchronously update the state, eg:\n ```jsx harmony\n import AsyncState from \"react-async-stateful\";\n\n const updateFromLocalStorage = () => {\n setAsyncState(asyncState => {\n const value = localStorage.getItem(\"key\");\n return AsyncState.resolve(asyncState, value);\n });\n };\n ```\n- `updateAsyncState` is the recommended way of updating. It will automatically update the state and re-render your component with a pending state allowing you to dipslay loading spinners ect.\n ```jsx harmony\n const submit = useCallback(() => {\n updateAsyncState(/*promise or an async function*/ async () => {\n const response = await api.get(`user/${userId}`); // thrown errors are automatically handled\n const user = formatUserObject(response.data);\n return user;\n });\n }, [userId]);\n \n // component will receive:\n asyncState.pending === true\n \n // then\n asyncState.resolved === true\n asyncState.value === user // resolved value\n \n // or if a rejection\n asyncState.rejected === true\n asyncState.error === Error // error instance\n ```\n\n## Submit vs Refresh\n\nThe default behaviour is that when the `updateAsyncState` function is called, the current value and errors are wiped and the state is put into an empty pending state.\n\nThis can be undesirable if you are merely refreshing data and want to keep the previous value whilst the new request is being made. To fix this you can pass the `refresh` option so that these are kept:\n\n```jsx harmony\nconst refreshList = () => {\n updateList(async () => {\n const response = await api.get(\"list\");\n return response.data;\n }, {refresh: true} /* <-- keep the current value whilst we are pending */);\n};\n```\n\n_whether submit or refresh were used is stored as `submitType` on the async state object_\n\n## The AsyncState object\n\n**Note:** All operations on async state **do not** mutate the original object\n\n```typescript jsx\n// typescript\nimport AsyncState from \"react-async-stateful\";\n\n// creating the state\nconst state = AsyncState.create(\"hello\");\nconsole.log(state.pristine); // true\nconsole.log(state.value); // hello\n\n// resolving the state\nconst resolvedState = AsyncState.resolve(state, \"world\");\nconsole.log(state.resolved); // true\nconsole.log(state.value); // world\n\n```\n\n#### Properties\n\n| key | type | description\n| --- | --- | --- \n| `defaultValue` | `T` or `undefined` | default value set at the object creation \n| `pristine` | `boolean` | have we been updated yet?\n| `pending` | `boolean` | is there an update to the state happening now?\n| `pendingAt` | `number` or `null` | when the update started\n| `resolved` | `boolean` | do we have a resolved value? if this is true then `value` must not be `undefined`\n| `resolvedAt` | `number` or `null` | when the value the was resolved \n| `rejected` | `boolean` | if an error occurred or the update was rejected. if this is true then `error` must not be `undefined`\n| `rejectedAt` | `number` or `null` | when the rejection happened 😢\n| `settled` | `boolean` | if the object is resolved/rejected and not pending\n| `settledAt` | `number` or `null` | when it was settled\n| `value` | `T` or `undefined` | the currently resolved value, if `undefined` we are not resolved \n| `error` | `Error` or `undefined` | the reason for the rejection, if `undefined` we are not rejected \n| `submitType` | `AsyncStateSubmitType` or `undefined` | what kind of submit was it? can be either `submit` or `refresh` \n\n## Typescript Utils\n\nTypescript has a cool feature allowing you to narrow the type of an object using methods. Supplied are some methods that will make null checking your async state objects easier:\n\n```typescript jsx\nimport AsyncState, {useAsyncState} from \"react-async-stateful\";\n\nconst [asyncState, _, updateAsyncState] = useAsyncState();\n\nrunUpdateThatWillHappenInTheFuture();\n\n/* Typescript will complain about the line below 😫 \n Even though our library provides a contract that if resolved is true\n `value` cannot be undefined the typescript compiler has no way of knowing this! */\n// return asyncState.resolved ?
{asyncState.value.id}
: \"Loading\";\n\n// Use `isResolved` and the compiler will be happy that it is definitely present:\nreturn AsyncState.isResolved(asyncState) ?