Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

relay-runtime

Package Overview
Dependencies
Maintainers
11
Versions
3563
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

relay-runtime

A core runtime for building GraphQL-driven applications.

  • 12.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.9M
decreased by-0.71%
Maintainers
11
Weekly downloads
 
Created

What is relay-runtime?

The relay-runtime package is a part of the Relay framework, which is a JavaScript framework for building data-driven React applications with GraphQL. It provides a runtime environment for managing and executing GraphQL queries, caching query results, and updating the UI. It is designed to be efficient, fast, and scalable.

What are relay-runtime's main functionalities?

Network Layer

The network layer is responsible for defining how Relay communicates with the GraphQL server. It uses a fetch function to send queries and mutations and process the responses.

import { Environment, Network, RecordSource, Store } from 'relay-runtime';

// Define a function that fetches the results of an operation (query/mutation/etc)
// and returns its results as a Promise:
function fetchQuery(operation, variables) {
  return fetch('/graphql', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      query: operation.text, // GraphQL text from input
      variables,
    }),
  }).then(response => {
    return response.json();
  });
}

// Create a network layer from the fetch function
const network = Network.create(fetchQuery);

// Create a record source to store the data
const store = new Store(new RecordSource());

// Create an environment using the configured network and store
const environment = new Environment({
  network,
  store,
});

Store and RecordSource

The store is where Relay keeps its cache of GraphQL data. RecordSource is the low-level storage API used by Store to manage records. Together, they enable the caching and management of query results.

import { Environment, Network, RecordSource, Store } from 'relay-runtime';

const store = new Store(new RecordSource());

const environment = new Environment({
  network: Network.create(fetchQuery),
  store,
});

Garbage Collection

Relay's store provides garbage collection capabilities to clean up data that is no longer referenced by any active queries, which helps in managing memory usage.

import { Environment, Network, RecordSource, Store } from 'relay-runtime';

const store = new Store(new RecordSource());
store.gc();

const environment = new Environment({
  network: Network.create(fetchQuery),
  store,
});

Optimistic Updates

Optimistic updates allow Relay to simulate the results of a mutation on the client side before the server responds, providing a snappier user experience.

import { commitMutation, graphql } from 'react-relay';
import { ConnectionHandler } from 'relay-runtime';

const mutation = graphql`
  mutation CommentMutation($input: CommentInput!) {
    comment(input: $input) {
      commentEdge {
        node {
          id
          text
        }
      }
    }
  }
`;

const optimisticResponse = {
  comment: {
    commentEdge: {
      node: {
        id: 'temp-id',
        text: 'This is a temporary comment',
      },
    },
  },
};

commitMutation(
  environment,
  {
    mutation,
    variables: { input: { text: 'Hello world!' } },
    optimisticResponse,
  }
);

Other packages similar to relay-runtime

Keywords

FAQs

Package last updated on 01 Sep 2021

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc