Skip to main content

FAQ

Why do I need to create the Isograph environment in a component? Can I just use a global environment?​

If you are using NextJS, it is extremely important to not create the environment at the top level (i.e. in module scope.) If you do this, NextJS will reuse the environment across requests, so different users will share the same environment!

Create the environment during the render of a component is sufficient to avoid this. However, you should also memoize the creation of the environment so that if (for whatever reason), your App component re-renders, you do not recreate the environment, thus losing data.

What if I want to run Isograph without Typescript?​

What if I want to run Isograph without Babel?​

The only thing the Babel plugin does is replace calls to iso(`entrypoint Type.FieldName`) with a require call to the default export of the Type/FieldName/entrypoint.ts file. If you instead import that yourself, Isograph continues to work.

The Babel plugin does not modify iso(`field ...`) literals.

How do I authenticate with an external API?​

You may need to provide a bearer token if you are using a public API, such as the GitHub API. See this GitHub demo for an example of how to do with a token that you receive from OAuth. See also the [...nextauth].tsx file in the same repo.

Why is there special handling of @component?​

How do IDs work?​

How do I suppress errors using the "on_invalid_id_type" config parameter?​

If you see an error like:

Unable to create schema.
Reason: The id field on "Pet" must have type "ID!".
This error can be suppressed using the "on_invalid_id_type" config parameter.

Then, you can suppress this error by adding options: { on_invalid_id_type: "ignore" } to your isograph.config.json file.