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

Update apollo-server.mdx #1621

Merged
merged 1 commit into from
Oct 10, 2022
Merged

Update apollo-server.mdx #1621

merged 1 commit into from
Oct 10, 2022

Conversation

chaiwa-berian
Copy link
Contributor

Update the examples on how to correctly add typeDefs and resolvers from graphql-scalars to your schema.

🚨 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.

See discusssion on Discord.

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
n the Usage with Apollo Server example https://www.graphql-scalars.dev/docs/usage/apollo-server#usage-with-apollo-server-1 it seems the spread operators for the schema may need to be cleaned up! I struggled a little bit to get it work(might help other beginners). For typedefs, only spread the scalarTypeDefs since the other typeDefs are already a string. And for resolvers, merge the two objects and not spread them into a new array.

I have added clearer comments and updated the code snippet like below:

const schema = makeExecutableSchema({
  typeDefs: [typeDefs, ...scalarTypeDefs],
  resolvers: { ...resolvers, ...scalarResolvers },
});

Related #1620

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Screenshots/Sandbox (if appropriate/relevant):

Adding links to sandbox or providing screenshots can help us understand more about this PR and take action on it as appropriate

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Tested using my project here.

Test Environment:

  • OS: Linux Ubuntu
  • GraphQL Scalars Version: 16.5.0
  • NodeJS: 16.15.0

Checklist:

  • I have followed the CONTRIBUTING doc and the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests and linter rules pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

See discussion on Discord.

@vercel
Copy link

vercel bot commented Jun 4, 2022

@chaiwa-berian is attempting to deploy a commit to the The Guild Team on Vercel.

A member of the Team first needs to authorize it.

Update the examples on how to  correctly add `typeDefs` and `resolvers` from `graphql-scalars` to your schema.
@ardatan
Copy link
Collaborator

ardatan commented Oct 10, 2022

Thanks @chaiwa-berian !

import { resolvers } from "./src/resolvers"
// Example importing of your own defined type definitions
const typeDefs = fs.readFileSync(
path.join(path.resolve(), "./src/schema.graphql"),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never saw this pattern

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