This repository has been archived by the owner on Nov 11, 2023. It is now read-only.
Update README #153
Merged
Update README #153
Conversation
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
README.md
Outdated
| resolve: image => image && image.message, | ||
| }); | ||
|
|
||
| return <img alt="Here's a good boye!" src={imageUrl} />; |
There was a problem hiding this comment.
this will show broken image for a moment, not sure if it matters for the exampls
There was a problem hiding this comment.
So would you suggest
Suggested change
| return <img alt="Here's a good boye!" src={imageUrl} />; | |
| return imageUrl && <img alt="Here's a good boye!" src={imageUrl} />; |
?
README.md
Outdated
| {loading ? ( | ||
| "Deleting..." | ||
| ) : ( | ||
| <a |
There was a problem hiding this comment.
use button instead of onClick={e => { e.preventDefault();?
README.md
Outdated
| ``` | ||
|
|
||
| `Mutate` is strongly typed, and provides intelligent autocompletion out of the box, complete with available verbs and other self-documentation. | ||
| `useMutate` is strongly typed, and provides intelligent autocompletion out of the box, complete with available verbs et al. |
There was a problem hiding this comment.
Suggested change
| `useMutate` is strongly typed, and provides intelligent autocompletion out of the box, complete with available verbs et al. | |
| `useMutate` is strongly typed, and provides intelligent autocompletion out of the box, complete with available verbs etc. |
My guess et al. is less know than etc. or and others.
There was a problem hiding this comment.
Suggested change
| `useMutate` is strongly typed, and provides intelligent autocompletion out of the box, complete with available verbs et al. | |
| `useMutate` is strongly typed, and provides intelligent autocompletion out of the box, complete with available verbs. |
README.md
Outdated
|
|
||
| - an `interval` prop that will poll at a specified interval (defaults to polling 1 second), and | ||
| - an `until` prop that accepts a condition expressed as a function that returns a boolean value. When this condition is met, polling will stop. | ||
| - the signature of this function is `(data: T, response: Response) => boolean`. As a developer, you have access to the returned data, along with the response object in case you'd like to stop polling if `response.ok === false`, for example. | ||
| - the signature of this function is `(data: T, response: ResponseInit) => boolean`. As a developer, you have access to the returned data, along with the response object in case you'd like to stop polling if `response.ok === false`, for example. |
There was a problem hiding this comment.
not part of the list. Make it a paragraph
README.md
Outdated
|
|
||
| #### [Full `Poll` Component API](src/Poll.tsx#L53-L101) | ||
|
|
||
| ### Code Generation | ||
|
|
||
| Restful React is able to generate _type-safe_ React components from any valid OpenAPI v3 or Swagger v2 specification, either in `yaml` or `json` formats. | ||
| `restful-react` is able to generate _type-safe_ React components from any valid OpenAPI v3 or Swagger v2 specification, either in `yaml` or `json` formats. |
There was a problem hiding this comment.
Suggested change
| `restful-react` is able to generate _type-safe_ React components from any valid OpenAPI v3 or Swagger v2 specification, either in `yaml` or `json` formats. | |
| `restful-react` is able to generate React components with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in `yaml` or `json` formats. |
?
stereobooster
previously approved these changes
Oct 8, 2019
mpotomin
suggested changes
Oct 15, 2019
|
|
||
| [](https://codesandbox.io/s/30n66z45mq) | ||
| [](https://codesandbox.io/s/restful-react-demos-vjets) |
There was a problem hiding this comment.
This Demo on Codesandbox is broken
|
|
||
| Consider, | ||
|
|
||
| [](https://codesandbox.io/s/30n66z45mq) | ||
| [](https://codesandbox.io/s/restful-react-demos-vjets) |
There was a problem hiding this comment.
Same demo link as the the one above. is it intentional?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Why
We have amazing things but they're undocumented. This aims to fix #146.