chore: increase documentation across the codebase #503
Conversation
* simplify example folder
* setup now returns the created config
Co-authored-by: Elliot Milco <[email protected]>
…source into documentation
|
🙌 |
|
|
||
| ## What is a Node? | ||
|
|
||
| A `Node` is a refetchable GraphQL resource. All `Node`s must have a _globally unique ID_ and be fetchable via this ID. Relay will refetch these resources in the following way: |
There was a problem hiding this comment.
suggestion: maybe reference the gql interface, perhaps even update the code snippet below such that Foo implements Node? The Node interface is the fundamental part, right? it's the smart impl that's the magic?
| * first. | ||
| * | ||
| * Even if multiple fields use the `createResolve` helper, there will only | ||
| * be one network request as the requests will be batched via a DataLoader. |
There was a problem hiding this comment.
question: there needs to be batch-compliant endpoints on the backing api to support, right? does the example api need to call that out?
There was a problem hiding this comment.
I never answered this but that is orthogonal to the createResolve helper. What you are talking about is the DataLoader that is by default used in the HttpApi class.
That is a good point though and dataloading should be the next portion.
| '/graphql', | ||
| graphqlHTTP({ | ||
| schema: new GraphQLSchema({ query: Query }), | ||
| graphiql: true, |
There was a problem hiding this comment.
question: I havent used this in a while! adding the playground (if you need it) is pretty simple (middleware)
There was a problem hiding this comment.
I don't quite understand what this does? Currently the GraphiQL Playground is being hosted and accessible via localhost when running yarn start.
|
|
||
| The [NodeType](./src/types/NodeType.ts#) class does two things: | ||
| 1. it defines the `Node` type required by Relay | ||
| 1. it implements a solution to asynchronously resolve the Node by fetching it from a backing REST API |
There was a problem hiding this comment.
suggestion: just want to make sure I understanding the semantics clearly, this is most likely just me making noise...
- does it define the
Nodeor does it provide the concrete implementation for aNodein the relay sense? - the solution is just an implementation of the relay gql interface that's got some smarts, right? provides implementation for
node,nodesby asynchronously fetching...?
| } | ||
| ``` | ||
|
|
||
| ## The Node Class |
There was a problem hiding this comment.
question: this is kind of ambiguous to me, should I be reading this something like, "The NodeType, a sensible Node Implementation"?
This PR aims to provide meaningful documentation on this library. This comes in three forms: