relay-runtime

Relay Runtime

A set of Relay APIs responsible for data fetching, reading and normalization of the GraphQL data.

Example:

// @flow strict-local

import type {FetchFunction} from 'relay-runtime';

const {
  Environment,
  Network,
  Observable,
  RecordSource,
  Store,
  fetchQuery,
  graphql,
} = require('relay-runtime');

const fetchFn: FetchFunction = function (request, variables) {
  return new Observable.create(source => {
    fetch('/my-graphql-api', {
      method: 'POST',
      body: JSON.stringify({
        text: request.text,
        variables,
      }),
    })
      .then(response => response.json())
      .then(data => source.next(data));
  });
};

const network = Network.create(fetchFn);
const store = new Store(new RecordSource());
const environment = new Environment({
  network,
  store,
});

fetchQuery(
  environment,
  graphql`
    query AppQuery($id: ID!) {
      user(id: $id) {
        name
      }
    }
  `,
  {id: 'my-node-id'},
).subscribe({
  error: error => {
    console.error(error);
  },
  next: data => {
    console.log(data);
  },
});

For complete API reference, visit https://relay.dev/.

Similar packages

Other packages similar to 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 is similar to relay-runtime in that it provides features for executing GraphQL operations, caching results, and updating the UI. Apollo Client is known for its flexibility and ease of integration with various view layers, not just React.

urql

urql is a lightweight and extensible GraphQL client for React, designed to be highly customizable and easy to understand. It offers similar functionalities to relay-runtime, such as executing GraphQL queries and mutations, caching, and optimistic updates. urql differentiates itself with a focus on simplicity and a smaller bundle size.

graphql-request

graphql-request is a minimal GraphQL client for making HTTP requests. It is much simpler than relay-runtime and is suitable for small applications or simple use cases where the overhead of a full-featured GraphQL client is not necessary. It does not provide a caching layer or advanced features like subscriptions and optimistic updates.