Comments (2)
Hi @asharnadeem ,
To achieve what you need, mappers can be used.
Using base plugins
Here's what you can do if you use @graphql-codegen/typescript-resolvers
- Create a type that you want to return into a
Book
type in the schema e.g.
// src/mappers.ts
export type BookMapper = {
id: string;
name: string;
}
- Then, wire it up in codegen config:
// codegen.ts
import type { CodegenConfig } from '@graphql-codegen/cli';
const config: CodegenConfig = {
schema: '**/schema.graphql'
generates: {
'src/types.generated.ts': {
plugins: ['typescript', 'typescript-resolvers'],
config: {
mappers: {
Book: './mappers#BookMapper'
}
}
}
}
}
export default config;
- Run codegen and you can now return
BookMapper
inQuery.book
Using Server Preset
Using base plugin can get repetitive and it also doesn't provide runtime safety. We recommend using Server Preset to get a more managed experience so you can focus more on developing features instead of worrying about types.
To set up server preset, here's what you do:
- Update codegen config
// codegen.ts
import type { CodegenConfig } from '@graphql-codegen/cli';
import { defineConfig } from '@eddeee888/gcg-typescript-resolver-files';
const config: CodegenConfig = {
schema: '**/schema.graphql'
generates: {
'src/schema': defineConfig(),
}
export default config;
- Make sure you schema is in the right module e.g.
# src/schema/schema.graphql
type Query {
book(id: ID!): Book!
}
# ... other types
- Add mappers into schema:
// src/schema/schema.mappers.ts
export type BookMapper = {
id: string;
name: string;
}
- Run codegen and mappers you can use
BookMapper
resolver.
Here's the full guide to integrate Server Preset into GraphQL Yoga or Apollo Server
from graphql-code-generator.
Hi @asharnadeem , I'll close this issue as it's an expected behaviour. If you have issues using mappers
or Server Preset, please create other issues and ping me.
from graphql-code-generator.
Related Issues (20)
- [Severity Vulnerability] - Uncontrolled resource consumption in package "braces" HOT 2
- #9962 causes issues with our schema: parts of the types in ResolversType map contradict other parts of the type (repro) HOT 8
- `InputMaybe` should explicitly include `undefined` HOT 3
- Disable fragmentMasking not working HOT 1
- Configure conditional directives
- Redundant suffix when handling anonymous operation names with user-provided `namingConvention` function
- Print missing dependency warnings for filetypes even if supported files match
- `ClientSideBaseVisitor.fragmentsGraph` is recomputed several times despite never changing HOT 2
- Supporting gql tag functions
- `documentMode: βstringβ` produces types incompatible with strict typescript
- [Bug] codgen creates invalid operations when queries include fragment definitions
- `verbatimModuleSyntax:true` in tsconfig.json causes generated files to fail type validation HOT 2
- Input fields with defaults should be optional for client and fields without defaults should not
- Map of operations implicitly has type `any[]` when no operations are found
- suggestion for handling resolved types HOT 1
- Installed with `relay-compiler` will cause `npm i -D relay-compiler@latest` to install v12 HOT 1
- Codegen CLI in watch mode doesn't respect "silent" configuration
- Broken linter on repo since eslint 9 update
- namingConvention shouldn't affect documentVariablePrefix/Suffix
- Rework isFragmentReady API
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from graphql-code-generator.