@types/relay-runtime
Advanced tools
@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.
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 });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 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 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.
npm install --save @types/relay-runtime
This package contains type definitions for relay-runtime ( https://github.com/facebook/relay ).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/relay-runtime
Additional Details
These definitions were written by Matt Martin https://github.com/voxmatt, Eloy Durán https://github.com/alloy.
FAQs
TypeScript definitions for relay-runtime
The npm package @types/relay-runtime receives a total of 112,255 weekly downloads. As such, @types/relay-runtime popularity was classified as popular.
We found that @types/relay-runtime demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.
Security News
CISA's KEV data is now on GitHub, offering easier access, API integration, commit history tracking, and automated updates for security teams and researchers.
Security News
Opengrep forks Semgrep to preserve open source SAST in response to controversial licensing changes.