rt2zz/redux-persist

Better docs for PersistGate onBeforeLift

Open

#944 opened on Dec 11, 2018

View on GitHub
 (1 comment) (7 reactions) (0 assignees)TypeScript (12,744 stars) (879 forks)batch import
docsgood first issue

Description

We should document if and how an async function (i.e. a Promise) can be passed to onBeforeLift. I.e. example code for what's trying to be done here: #921

Where to update: https://github.com/rt2zz/redux-persist/blob/master/docs/PersistGate.md

Contributor guide

Tech stack
reacttypescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Redux Persist basicsJavaScript Promises
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Update the PersistGate.md file in the docs folder. Reference issue #921 which illustrates an async onBeforeLift usage. Provide example code showing how to pass a Promise to onBeforeLift, including error handling if needed. Confirm the expected behavior with maintainers if unclear.