docs: list data provider methods explicitly
List and link required and optional data provider methods explicitly. Listing helps understand what actually the dataProvider object entails and linking helps the reader know ahead of time what's coming in the sections below. Also helps organize the overview better.
In the existing text, the names of methods are inferred from inside the dataProvider object signature . dataProvider object inside the code block is a signature - as the actual object should have method definitions which are mostly async functions. I wanted to mention about the signature.
IMPORTANT: Please do not create a Pull Request without creating an issue first.
Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.
Please provide enough information so that others can review your pull request:
Explain the details for making this change. What existing problem does the pull request solve?
Test plan (required)
Demonstrate the code is solid. If not, please add WIP: in its title.
Closing issues
Put closes #XXXX in your comment to auto-close the issue that your PR fixes (if such).
Self Check before Merge
Please check all items below before review.
- [ ] Corresponding issues are created/updated or not needed
- [ ] Docs are updated/provided or not needed
- [ ] Examples are updated/provided or not needed
- [ ] TypeScript definitions are updated/provided or not needed
- [ ] Tests are updated/provided or not needed
- [ ] Changesets are provided or not needed
⚠️ No Changeset found
Latest commit: f457c246b3337d722114ceb60bf389010b87e0da
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
Deploy Preview for refine-doc-live-previews ready!
Built without sensitive environment variables
| Name | Link |
|---|---|
| Latest commit | f457c246b3337d722114ceb60bf389010b87e0da |
| Latest deploy log | https://app.netlify.com/sites/refine-doc-live-previews/deploys/6358d32563037b00082ccc10 |
| Deploy Preview | https://deploy-preview-2909--refine-doc-live-previews.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site settings.
Hey @anewman15 thanks for the changes, looks much better this way. Just one thing and that's my fault 🤦 We've recently updated data providers and getMany, deleteMany, createMany and updateMany functions are now optional and can be skipped while creating a data provider (in that case, we call singular versions multiple times to achieve the same result)
Can we update the texts to reflect these changes? 🙏
Hey @anewman15 thanks for the changes, looks much better this way. Just one thing and that's my fault facepalm We've recently updated data providers and
getMany,deleteMany,createManyandupdateManyfunctions are now optional and can be skipped while creating a data provider (in that case, we call singular versions multiple times to achieve the same result)Can we update the texts to reflect these changes? pray
Hi @aliemir ,
I'm making the changes according to your update. It would help if I can have a look at the source files. Would you kindly share them ?
Also, is getApiUrl() also must ? Or is it optional ?
Thanks in advance!
Hey @anewman15 Here's the type definition for the data providers https://github.com/refinedev/refine/blob/next/packages/core/src/contexts/data/IDataContext.ts#L124 hope this helps 🙏