在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):graphql/graphql-relay-js开源软件地址(OpenSource Url):https://github.com/graphql/graphql-relay-js开源编程语言(OpenSource Language):TypeScript 85.1%开源软件介绍(OpenSource Introduction):Relay Library for GraphQL.jsThis is a library to allow the easy creation of Relay-compliant servers using the GraphQL.js reference implementation of a GraphQL server. Getting StartedA basic understanding of GraphQL and of the GraphQL.js implementation is needed to provide context for this library. An overview of GraphQL in general is available in the README for the Specification for GraphQL. This library is designed to work with the GraphQL.js reference implementation of a GraphQL server. An overview of the functionality that a Relay-compliant GraphQL server should provide is in the GraphQL Relay Specification on the Relay website. That overview describes a simple set of examples that exist as tests in this repository. A good way to get started with this repository is to walk through that documentation and the corresponding tests in this library together. Using Relay Library for GraphQL.jsInstall Relay Library for GraphQL.js npm install graphql graphql-relay When building a schema for GraphQL.js, the provided library functions can be used to simplify the creation of Relay patterns. ConnectionsHelper functions are provided for both building the GraphQL types for connections and for implementing the
An example usage of these methods from the test schema: var { connectionType: ShipConnection } = connectionDefinitions({
nodeType: shipType,
});
var factionType = new GraphQLObjectType({
name: 'Faction',
fields: () => ({
ships: {
type: ShipConnection,
args: connectionArgs,
resolve: (faction, args) =>
connectionFromArray(
faction.ships.map((id) => data.Ship[id]),
args,
),
},
}),
}); This shows adding a Object IdentificationHelper functions are provided for both building the GraphQL types for nodes and for implementing global IDs around local IDs.
An example usage of these methods from the test schema: var { nodeInterface, nodeField } = nodeDefinitions(
(globalId) => {
var { type, id } = fromGlobalId(globalId);
return data[type][id];
},
(obj) => {
return obj.ships ? factionType : shipType;
},
);
var factionType = new GraphQLObjectType({
name: 'Faction',
fields: () => ({
id: globalIdField(),
}),
interfaces: [nodeInterface],
});
var queryType = new GraphQLObjectType({
name: 'Query',
fields: () => ({
node: nodeField,
}),
}); This uses MutationsA helper function is provided for building mutations with single inputs and client mutation IDs.
An example usage of these methods from the test schema: var shipMutation = mutationWithClientMutationId({
name: 'IntroduceShip',
inputFields: {
shipName: {
type: new GraphQLNonNull(GraphQLString),
},
factionId: {
type: new GraphQLNonNull(GraphQLID),
},
},
outputFields: {
ship: {
type: shipType,
resolve: (payload) => data['Ship'][payload.shipId],
},
faction: {
type: factionType,
resolve: (payload) => data['Faction'][payload.factionId],
},
},
mutateAndGetPayload: ({ shipName, factionId }) => {
var newShip = {
id: getNewShipId(),
name: shipName,
};
data.Ship[newShip.id] = newShip;
data.Faction[factionId].ships.push(newShip.id);
return {
shipId: newShip.id,
factionId: factionId,
};
},
});
var mutationType = new GraphQLObjectType({
name: 'Mutation',
fields: () => ({
introduceShip: shipMutation,
}),
}); This code creates a mutation named Our mutation type then creates the ContributingAfter cloning this repo, ensure dependencies are installed by running: npm install This library is written in ES6 and uses Babel for ES5 transpilation and TypeScript for type safety. Widely consumable JavaScript can be produced by running: npm run build Once After developing, the full test suite can be evaluated by running: npm test Opening a PRWe actively welcome pull requests. Learn how to contribute. This repository is managed by EasyCLA. Project participants must sign the free (GraphQL Specification Membership agreement before making a contribution. You only need to do this one time, and it can be signed by individual contributors or their employers. To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you. You can find detailed information here. If you have issues, please email [email protected]. If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the GraphQL Foundation. ChangelogChanges are tracked as GitHub releases. Licensegraphql-relay-js is MIT licensed. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论