@types/relay-runtime

What is @types/relay-runtime?

@types/relay-runtime provides TypeScript type definitions for the relay-runtime library, which is a core part of Relay, a JavaScript framework for building data-driven React applications.

What are @types/relay-runtime's main functionalities?

Environment Configuration

This feature allows you to configure the Relay environment, which is essential for setting up the network layer and the store for managing GraphQL data.

const environment = new Environment({ network, store });

GraphQL Queries

This feature allows you to define GraphQL queries using the `graphql` tagged template literal, which is then used to fetch data from the GraphQL server.

const query = graphql`query AppQuery { viewer { id } }`;

Fragment Containers

This feature allows you to create fragment containers that specify the data requirements for a component, enabling Relay to fetch only the necessary data.

const MyComponent = createFragmentContainer(Component, { viewer: graphql`fragment MyComponent_viewer on Viewer { id }` });

Mutations

This feature allows you to commit mutations to the GraphQL server, enabling you to modify data and update the client-side store accordingly.

commitMutation(environment, { mutation, variables, onCompleted, onError });

Other packages similar to @types/relay-runtime

apollo-client

Apollo Client is a comprehensive state management library for JavaScript that enables you to manage both local and remote data with GraphQL. It offers similar functionalities to relay-runtime but with a different approach to caching and state management.

urql

urql is a highly customizable and versatile GraphQL client for React that provides a simpler and more flexible alternative to relay-runtime. It focuses on ease of use and extensibility.

graphql-request

graphql-request is a minimal GraphQL client that allows you to send queries and mutations to a GraphQL server. It is much simpler than relay-runtime and does not include advanced features like caching or fragment containers.

README

Installation

npm install --save @types/relay-runtime

Summary

This package contains type definitions for relay-runtime (https://github.com/facebook/relay).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/relay-runtime.

Additional Details

• Last updated: Mon, 02 Dec 2024 15:02:40 GMT
• Dependencies: none

Credits

These definitions were written by Eloy Durán, Marais Rossouw, Lorenzo Di Giacomo, and Levi Buzolic.