-
Notifications
You must be signed in to change notification settings - Fork 674
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Docs for v5 changes. #636
Merged
Merged
Changes from 49 commits
Commits
Show all changes
52 commits
Select commit
Hold shift + click to select a range
ea1894e
Update JSDocs for `createStructuredSelector`
aryaemami59 15feb03
Add units tests to showcase `createStructuredSelector`s second functi…
aryaemami59 e4fe262
Add more type tests
aryaemami59 f8cdab2
Fix `README` for v5.
aryaemami59 acb1c9d
Add `testUtils` file
aryaemami59 94fef76
Add `createCurriedSelector`
aryaemami59 93820c6
Fix issues with topic expansion in docs.
aryaemami59 8db66aa
Merge https://github.com/reduxjs/reselect into v5-docs
aryaemami59 212e889
Resolve merge conflicts
aryaemami59 c6dab42
Fix docs for selectors that take arguments
aryaemami59 5b30a5a
Add `@typescript/analyze-trace` to `devDependencies`
aryaemami59 d2987bd
Create separate `NPM` command for `@typescript/analyze-trace`
aryaemami59 1e091af
Add JSDocs for `MergeParameters`.
aryaemami59 5ff1968
Fix TS bug related to `OutputSelector`.
aryaemami59 7201083
Add JSDocs for `createCurriedSelector`
aryaemami59 12e2411
Fix toggle sections in `README`
aryaemami59 7e22290
Fix `TypedCreateSelector` in `README`
aryaemami59 bb82bf3
Add `createCurriedSelectorCreator` to docs.
aryaemami59 3b793a3
Fix library names formatting in docs
aryaemami59 bdf43e5
Fix API collapsed sections
aryaemami59 0112f1a
Remove `ParametricSelector` and `OutputParametricSelector`
aryaemami59 9f7c288
Remove `ParametricSelector` and `OutputParametricSelector` from type …
aryaemami59 76ad4fa
Remove `connect` reference from `createStructuredSelector` descriptio…
aryaemami59 dfe31f4
Move `createSelectorCreator` to be directly after `createSelector` in…
aryaemami59 55361f3
Remove duplicate explanation in the `autotrackMemoize` section in docs.
aryaemami59 b0fae92
Rename `autotrackMemoize` to `unstable_autotrackMemoize` in examples …
aryaemami59 af90f43
Add experimental warning label to `unstable_autotrackMemoize` in docs.
aryaemami59 1a5c72b
Fix `weakMapMemoize` examples.
aryaemami59 1768c20
Fix JSDocs for `weakMapMemoize`.
aryaemami59 191614c
Tweak example titles for memoize functions in docs.
aryaemami59 917afa2
Replace `createCurriedSelector` API with copy paste pattern in docs.
aryaemami59 de37737
Slightly Modify `createParametricSelectorHook` in docs
aryaemami59 38e7a40
Fix installation guide in docs
aryaemami59 3845404
Modify example for `createStructuredSelector` in docs.
aryaemami59 4458991
Add explanation underneath "How Does Reselect Work" in docs.
aryaemami59 4bb0655
Modify JSDocs for `createStructuredSelector` to match the docs.
aryaemami59 3871ae4
Update `createStructuredSelector` link in docs
aryaemami59 04d8241
Update `examples.test.ts` to match the docs.
aryaemami59 55ca12e
Add `dependencyRecomputations` and `resetDependencyRecomputations` to…
aryaemami59 3912374
Fix title of tests in `weakmapMemoize.spec.ts`.
aryaemami59 6f94ea7
Add "esModuleInterop" to tsconfig for vitest type tests.
aryaemami59 a031621
Add initial vitest type tests for `createSelectorCreator` and `create…
aryaemami59 7215304
Fix benchmarks for `orderOfExecution.bench.ts` and `weakMapMemoize.be…
aryaemami59 4595ef6
Update `yarn.lock`.
aryaemami59 3de5110
Remove changes unrelated to docs.
aryaemami59 97b73eb
Update lockfile
aryaemami59 ecd40bc
Remove other changes not related to docs
aryaemami59 2d6a4dd
Merge branch 'reduxjs:master' into v5-docs
aryaemami59 42dad9a
Fix links in JSDocs to match links in`README`
aryaemami59 999ca66
Remove some details wrappers and add additional descriptions
markerikson 47fd0b5
Tweak TOC
markerikson c536318
Remove "Top-Level Selectors" since createSlice handles this in RTK 2.0
markerikson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <mxfile host="65bd71144e" scale="1" border="0"> | ||
| <diagram id="s5zgOlhoY8HzJwKQ5w-s" name="Page-1"> | ||
| <mxGraphModel dx="1244" dy="636" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="2000" pageHeight="2000" background="#C7FFFB" math="0" shadow="1"> | ||
| <root> | ||
| <mxCell id="0"/> | ||
| <mxCell id="1" parent="0"/> | ||
| <mxCell id="7" value="" style="group;aspect=fixed;shadow=1;" vertex="1" connectable="0" parent="1"> | ||
| <mxGeometry x="60" y="460" width="681.5" height="290" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="2" value="Are arguments same as last time?" style="whiteSpace=wrap;html=1;rounded=1;shadow=1;aspect=fixed;" parent="7" vertex="1"> | ||
| <mxGeometry x="250" y="20" width="150" height="80" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="3" value="Return result." style="whiteSpace=wrap;html=1;rounded=1;shadow=1;" parent="7" vertex="1"> | ||
| <mxGeometry x="460" y="180" width="110" height="60" as="geometry"/> | ||
| </mxCell> | ||
| <object label="Yes" id="4"> | ||
| <mxCell style="edgeStyle=none;html=1;entryX=0;entryY=0;entryDx=0;entryDy=0;shadow=1;" parent="7" source="2" target="3" edge="1"> | ||
| <mxGeometry relative="1" as="geometry"/> | ||
| </mxCell> | ||
| </object> | ||
| <mxCell id="5" value="Run function again." style="whiteSpace=wrap;html=1;rounded=1;shadow=1;" parent="7" vertex="1"> | ||
| <mxGeometry x="30" y="180" width="150" height="60" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="6" value="No" style="edgeStyle=none;html=1;entryX=1;entryY=0;entryDx=0;entryDy=0;shadow=1;" parent="7" source="2" target="5" edge="1"> | ||
| <mxGeometry relative="1" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="8" value="Untitled Layer" parent="0"/> | ||
| </root> | ||
| </mxGraphModel> | ||
| </diagram> | ||
| </mxfile> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <mxfile host="65bd71144e"> | ||
| <diagram id="hFjyuBP9kS8yiWHOacYP" name="Page-1"> | ||
| <mxGraphModel dx="792" dy="1668" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" background="#C7FFFB" math="0" shadow="0"> | ||
| <root> | ||
| <mxCell id="0"/> | ||
| <mxCell id="1" parent="0"/> | ||
| <mxCell id="15" value="" style="group" vertex="1" connectable="0" parent="1"> | ||
| <mxGeometry x="70" y="-110" width="930" height="440" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="2" value="Are arguments same as last time?" style="whiteSpace=wrap;html=1;rounded=1;shadow=1;" parent="15" vertex="1"> | ||
| <mxGeometry x="470.735" y="35.2" width="139.57750000000001" height="58.036" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="3" value="Return result." style="whiteSpace=wrap;html=1;rounded=1;shadow=1;" parent="15" vertex="1"> | ||
| <mxGeometry x="680" y="159.2" width="132.19" height="80" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="8" value="Yes" style="edgeStyle=none;html=1;entryX=0;entryY=0;entryDx=0;entryDy=0;shadow=1;" parent="15" source="2" target="3" edge="1"> | ||
| <mxGeometry relative="1" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="4" value="Run input selectors.<br>Are the results of input selectors same as last time?" style="whiteSpace=wrap;html=1;rounded=1;shadow=1;" parent="15" vertex="1"> | ||
| <mxGeometry x="251.88" y="158.4" width="168.12" height="81.6" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="9" value="No" style="edgeStyle=none;html=1;entryX=1;entryY=0;entryDx=0;entryDy=0;shadow=1;" parent="15" source="2" target="4" edge="1"> | ||
| <mxGeometry relative="1" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="6" value="Return result." style="whiteSpace=wrap;html=1;rounded=1;shadow=1;" parent="15" vertex="1"> | ||
| <mxGeometry x="470.7375" y="310" width="135.625" height="44" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="13" value="Yes" style="edgeStyle=none;html=1;entryX=0;entryY=0;entryDx=0;entryDy=0;shadow=1;" parent="15" source="4" target="6" edge="1"> | ||
| <mxGeometry relative="1" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="7" value="Run result function." style="whiteSpace=wrap;html=1;rounded=1;shadow=1;" parent="15" vertex="1"> | ||
| <mxGeometry x="59.9975" y="310" width="135.625" height="44" as="geometry"/> | ||
| </mxCell> | ||
| <mxCell id="14" value="No" style="edgeStyle=none;html=1;entryX=1;entryY=0;entryDx=0;entryDy=0;shadow=1;" parent="15" source="4" target="7" edge="1"> | ||
| <mxGeometry relative="1" as="geometry"/> | ||
| </mxCell> | ||
| </root> | ||
| </mxGraphModel> | ||
| </diagram> | ||
| </mxfile> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✋ Can you also move all the types changes to a separate PR as well? That would make this easier to review and keep track of
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't really "change" much of the types. I did added some more type expansions for hover-previews, and fixed a small inference issue with
OutputSelectorthat was coming fromExtractReturnType.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, can you still move those to a separate PR just so they're easier to read through?