https://github.com/thinkmill/graphql-ts
Type-safety for constructing GraphQL schemas in TypeScript
https://github.com/thinkmill/graphql-ts
Last synced: 11 months ago
JSON representation
Type-safety for constructing GraphQL schemas in TypeScript
- Host: GitHub
- URL: https://github.com/thinkmill/graphql-ts
- Owner: Thinkmill
- License: mit
- Created: 2021-06-07T23:09:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-14T00:33:31.000Z (11 months ago)
- Last Synced: 2025-03-14T00:36:23.177Z (11 months ago)
- Language: TypeScript
- Homepage: https://docsmill.dev/npm/@graphql-ts/schema
- Size: 1.17 MB
- Stars: 18
- Watchers: 11
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @graphql-ts/schema
`@graphql-ts/schema` is a thin wrapper around
[GraphQL.js](https://github.com/graphql/graphql-js) providing type-safety for
constructing GraphQL Schemas while avoiding type-generation, [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html)
and [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html).
```ts
import { gWithContext } from "@graphql-ts/schema";
import { GraphQLSchema, graphql } from "graphql";
type Context = {
loadPerson: (id: string) => Person | undefined;
loadFriends: (id: string) => Person[];
};
const g = gWithContext();
type g = gWithContext.infer;
type Person = {
id: string;
name: string;
};
const Person: g> = g.object()({
name: "Person",
fields: () => ({
id: g.field({ type: g.nonNull(g.ID) }),
name: g.field({ type: g.nonNull(g.String) }),
friends: g.field({
type: g.list(g.nonNull(Person)),
resolve(source, _, context) {
return context.loadFriends(source.id);
},
}),
}),
});
const Query = g.object()({
name: "Query",
fields: {
person: g.field({
type: Person,
args: {
id: g.arg({ type: g.nonNull(g.ID) }),
},
resolve(_, args, context) {
return context.loadPerson(args.id);
},
}),
},
});
const schema = new GraphQLSchema({
query: Query,
});
{
const people = new Map([
["1", { id: "1", name: "Alice" }],
["2", { id: "2", name: "Bob" }],
]);
const friends = new Map([
["1", ["2"]],
["2", ["1"]],
]);
const contextValue: Context = {
loadPerson: (id) => people.get(id),
loadFriends: (id) => {
return (friends.get(id) ?? [])
.map((id) => people.get(id))
.filter((person) => person !== undefined) as Person[];
},
};
graphql({
source: `
query {
person(id: "1") {
id
name
friends {
id
name
}
}
}
`,
schema,
contextValue,
}).then((result) => {
console.log(result);
});
}
```