Skip to content
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

[WIP]: docs(general): 📘 update documentation to reflect the new changes #123

Merged
merged 3 commits into from
Nov 11, 2023

Conversation

luii
Copy link
Contributor

@luii luii commented Nov 8, 2023

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Copy link

stackblitz bot commented Nov 8, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@luii luii changed the title docs(general): 📘 update documentation to reflect the new changes [WIP]: docs(general): 📘 update documentation to reflect the new changes Nov 8, 2023
@luii
Copy link
Contributor Author

luii commented Nov 8, 2023

@NetanelBasal A couple of questions:

  • The persisted query was relying on keepPreviousData now its relying on placeholderData, can i remove this example or should this be replaced?
  • You introduced useMutationResult for version 1.0 do we still need this example or wont this be in 2.0.0?
  • Should we keep the Constructor DI section or do you think this is not needed anymore with the introduction of the inject*() convention in this library?

@NetanelBasal
Copy link
Member

  • persisted query is removed
  • useMutationResult is removed
  • Constructor DI is removed

Docs should be:
query ( should show the fromPromise and the aborted signal you can optionally pass when you need to cancel the underline request)
infinite query
pagination
mutation
operators
config
is fetching/mutating
devtools
ssr
and showing signal where it supported

@NetanelBasal
Copy link
Member

@luii I made more changes:

  • intersectResults$ - Rx version
  • intersectResults - Experimental signal support
  • Create the query observer only upon subscription

2dce8e0

@luii
Copy link
Contributor Author

luii commented Nov 10, 2023

@NetanelBasal we maybe should revisit if SSR is still working?
Also, would it make sense to add makeEnvironmentProviders to the provideQueryClientOptions provider to only limit it to EnvironmentProviders and not ComponentProviders?

@netanel-utila
Copy link

Yes

@netanel-utila
Copy link

I will take it from here. It will be great if you can take the playground and we can release on monday

@luii
Copy link
Contributor Author

luii commented Nov 11, 2023

Okay, besides the styling, does the playground need a certain examples?

@netanel-utila
Copy link

Maybe a page that shows the operators and intersections functionality. That's all for now

@NetanelBasal NetanelBasal marked this pull request as ready for review November 11, 2023 17:42
@NetanelBasal NetanelBasal merged commit 3858254 into ngneat:next Nov 11, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants