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 (842 forks)batch import
docsgood first issue

Repository metrics

Stars
 (12,958 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Read the referenced issue #921 to understand the async use case, then edit the PersistGate.md file to add an example of passing an async function to onBeforeLift.
Tech stack
typescriptreact
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85