Skip to content

Commit 263626c

Browse files
refactor: rename defineType to defineField across documentation and examples
1 parent e7b73a9 commit 263626c

File tree

23 files changed

+55
-73
lines changed

23 files changed

+55
-73
lines changed

.docs/api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Complete reference for resolver definition utilities:
4040
- **defineQuery()** - Define query-only resolvers
4141
- **defineMutation()** - Define mutation-only resolvers
4242
- **defineSubscription()** - Define subscription-only resolvers
43-
- **defineType()** - Define custom type field resolvers
43+
- **defineField()** - Define custom type field resolvers
4444
- **defineDirective()** - Define custom GraphQL directives
4545
- **defineGraphQLConfig()** - Define GraphQL server configuration
4646
- **defineSchema()** - Define schema with validation (Standard Schema)

.docs/api/apollo-utilities.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ interface ReferenceResolver<TContext> {
366366
```typescript
367367
import type { UserResolvers } from '#graphql/server'
368368
369-
export const userResolvers: UserResolvers = defineType({
369+
export const userResolvers: UserResolvers = defineField({
370370
User: {
371371
__resolveReference: async (reference, context) => {
372372
// reference contains fields marked with @key
@@ -583,7 +583,7 @@ const server = new ApolloServer({
583583
Always implement `__resolveReference` for federated types:
584584

585585
```typescript
586-
export const userResolvers = defineType({
586+
export const userResolvers = defineField({
587587
User: {
588588
__resolveReference: async (reference, context) => {
589589
// Resolve entity from its key fields
@@ -598,7 +598,7 @@ export const userResolvers = defineType({
598598
When referencing types from other subgraphs, return a reference object:
599599

600600
```typescript
601-
export const postResolvers = defineType({
601+
export const postResolvers = defineField({
602602
Post: {
603603
author: (post) => {
604604
// Don't resolve the entire user, return a reference

.docs/api/resolver-functions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -328,14 +328,14 @@ export const channelSubscriptions = defineSubscription({
328328

329329
---
330330

331-
## defineType()
331+
## defineField()
332332

333333
Define custom type resolvers (field resolvers for GraphQL types).
334334

335335
### Signature
336336

337337
```typescript
338-
function defineType(resolvers: Resolvers): Resolvers
338+
function defineField(resolvers: Resolvers): Resolvers
339339
```
340340

341341
### Parameters
@@ -351,7 +351,7 @@ Returns the same `Resolvers` object with full type safety.
351351
#### Basic Type Resolver
352352

353353
```typescript
354-
export const userTypeResolvers = defineType({
354+
export const userTypeResolvers = defineField({
355355
User: {
356356
fullName: (parent) => {
357357
return `${parent.firstName} ${parent.lastName}`
@@ -371,7 +371,7 @@ export const userTypeResolvers = defineType({
371371
#### Relationship Resolvers
372372

373373
```typescript
374-
export const postTypeResolvers = defineType({
374+
export const postTypeResolvers = defineField({
375375
Post: {
376376
author: async (parent, _args, context) => {
377377
return await context.db.users.findById(parent.authorId)
@@ -397,7 +397,7 @@ export const postTypeResolvers = defineType({
397397
#### Computed Fields
398398

399399
```typescript
400-
export const productTypeResolvers = defineType({
400+
export const productTypeResolvers = defineField({
401401
Product: {
402402
finalPrice: (parent) => {
403403
if (parent.discount) {

.docs/api/type-definitions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ For each GraphQL type in your schema, a specific resolver type is generated:
174174
```typescript
175175
import type { PostResolvers, UserResolvers } from '#graphql/server'
176176

177-
export const userTypeResolvers: UserResolvers = defineType({
177+
export const userTypeResolvers: UserResolvers = defineField({
178178
User: {
179179
fullName: parent => `${parent.firstName} ${parent.lastName}`,
180180
posts: async (parent, _args, context) => {
@@ -183,7 +183,7 @@ export const userTypeResolvers: UserResolvers = defineType({
183183
}
184184
})
185185

186-
export const postTypeResolvers: PostResolvers = defineType({
186+
export const postTypeResolvers: PostResolvers = defineField({
187187
Post: {
188188
author: async (parent, _args, context) => {
189189
return await context.db.users.findById(parent.authorId)

.docs/api/virtual-imports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ export const mutations: MutationResolvers = defineMutation({
111111
```typescript
112112
import type { PostResolvers, UserResolvers } from '#graphql/server'
113113

114-
export const userTypes: UserResolvers = defineType({
114+
export const userTypes: UserResolvers = defineField({
115115
User: {
116116
fullName: parent => `${parent.firstName} ${parent.lastName}`,
117117
posts: async (parent, _args, context) => {

.docs/contributing/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ export function defineQuery(query: QueryResolvers): Resolvers
199199
export function defineMutation(mutation: MutationResolvers): Resolvers
200200

201201
// Define custom type resolvers
202-
export function defineType<T>(type: T): T
202+
export function defineField<T>(type: T): T
203203

204204
// Define custom directives
205205
export function defineDirective(directive: DirectiveConfig): DirectiveConfig

.docs/ecosystem/nuxt-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Auto-imported utilities include:
7676
- `defineQuery`
7777
- `defineMutation`
7878
- `defineSubscription`
79-
- `defineType`
79+
- `defineField`
8080
- `defineGraphQLConfig`
8181
- `defineSchema`
8282
- `defineDirective`

.docs/guide/auto-discovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ The scanner looks for named exports using these functions:
256256
- `defineResolver`
257257
- `defineQuery`
258258
- `defineMutation`
259-
- `defineType`
259+
- `defineField`
260260
- `defineSubscription`
261261
- `defineDirective`
262262

.docs/guide/performance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Optimization tips for GraphQL resolvers, caching strategies, and batching.
1515

1616
```ts
1717
// Bad: N+1 queries
18-
export const postTypes = defineType({
18+
export const postTypes = defineField({
1919
Post: {
2020
author: async (parent, args, context) => {
2121
// This runs once per post!
@@ -39,7 +39,7 @@ const userLoader = new DataLoader(async (ids: readonly string[]) => {
3939
return ids.map(id => users.find(u => u.id === id))
4040
})
4141

42-
export const postTypes = defineType({
42+
export const postTypes = defineField({
4343
Post: {
4444
author: parent => userLoader.load(parent.authorId),
4545
},

.docs/guide/resolvers.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ category: Guide
77

88
<FunctionInfo fn="resolvers"/>
99

10-
Master GraphQL resolvers with `defineResolver`, `defineQuery`, `defineMutation`, `defineType`, and `defineSubscription`.
10+
Master GraphQL resolvers with `defineResolver`, `defineQuery`, `defineMutation`, `defineField`, and `defineSubscription`.
1111

1212
## What are Resolvers?
1313

@@ -93,13 +93,13 @@ export const userMutations = defineMutation({
9393
})
9494
```
9595

96-
### defineType
96+
### defineField
9797

9898
Define field resolvers for custom types:
9999

100100
```ts
101101
// server/graphql/users/types.resolver.ts
102-
export const userTypes = defineType({
102+
export const userTypes = defineField({
103103
User: {
104104
// Resolve the posts field
105105
posts: async (parent, args, context) => {
@@ -176,7 +176,7 @@ export const userQueries = defineQuery({
176176
}),
177177
})
178178

179-
export const userTypes = defineType({
179+
export const userTypes = defineField({
180180
User: {
181181
posts: (parent) => {
182182
// parent is the User object from the query resolver
@@ -303,7 +303,7 @@ type Post {
303303
```
304304

305305
```ts
306-
export const postTypes = defineType({
306+
export const postTypes = defineField({
307307
Post: {
308308
// Resolve author relationship
309309
author: async (parent, args, context) => {
@@ -341,7 +341,7 @@ const userLoader = new DataLoader(async (userIds: readonly string[]) => {
341341
return userIds.map(id => users.find(u => u.id === id))
342342
})
343343

344-
export const postTypes = defineType({
344+
export const postTypes = defineField({
345345
Post: {
346346
// Use DataLoader - batches and caches requests
347347
author: async (parent) => {
@@ -443,7 +443,7 @@ export const userMutations = defineMutation({
443443

444444
```ts
445445
// server/graphql/users/types.resolver.ts
446-
export const userTypes = defineType({
446+
export const userTypes = defineField({
447447
User: {
448448
posts: () => [...],
449449
},
@@ -657,7 +657,7 @@ export const postMutations = defineMutation({
657657
},
658658
})
659659

660-
export const postTypes = defineType({
660+
export const postTypes = defineField({
661661
Post: {
662662
author: async (parent, args, context) => {
663663
return await context.db.user.findUnique({

0 commit comments

Comments
 (0)