@remix-run/server-runtime

What is @remix-run/server-runtime?

@remix-run/server-runtime is a package that provides server-side utilities and abstractions for building web applications with Remix. It allows developers to handle server-side rendering, data loading, and other server-side logic in a structured and efficient manner.

What are @remix-run/server-runtime's main functionalities?

Server-Side Rendering

This feature allows you to handle server-side rendering with Remix. The `createRequestHandler` function is used to create a request handler that can be integrated with an Express server.

const { createRequestHandler } = require('@remix-run/server-runtime');
const express = require('express');
const app = express();

app.all('*', createRequestHandler({
  getLoadContext() {
    // Provide context for loaders
    return {};
  }
}));

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Data Loading

This feature allows you to load data on the server side before rendering a page. The `json` function is used to return JSON responses from loaders.

const { json } = require('@remix-run/server-runtime');

async function loader({ request }) {
  const data = await fetchDataFromAPI();
  return json(data);
}

Error Handling

This feature allows you to handle errors in your server-side logic. The `json` function can be used to return error responses with appropriate status codes.

const { json } = require('@remix-run/server-runtime');

async function loader({ request }) {
  try {
    const data = await fetchDataFromAPI();
    return json(data);
  } catch (error) {
    return json({ error: error.message }, { status: 500 });
  }
}

Other packages similar to @remix-run/server-runtime

next

Next.js is a popular React framework that provides server-side rendering, static site generation, and API routes. It offers a more opinionated and integrated approach compared to @remix-run/server-runtime, which is more focused on providing utilities for server-side logic in Remix applications.

express

Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. While it does not provide server-side rendering out of the box, it can be used in conjunction with other libraries to achieve similar functionality to @remix-run/server-runtime.

koa

Koa is a new web framework designed by the team behind Express, which aims to be a smaller, more expressive, and more robust foundation for web applications and APIs. Like Express, it does not provide server-side rendering out of the box but can be extended with middleware to achieve similar functionality.

README

@remix-run/server-runtime

Remix supports multiple server runtimes:

• Node
• Cloudflare
• Deno (Experimental 🧪)

Support for each runtime is provided by a corresponding Remix package:

• @remix-run/node
• @remix-run/cloudflare
• @remix-run/deno

This package defines a "Remix server runtime interface" that each runtime package must conform to.

Each Remix server runtime package MUST:

• Implement and export values for each type in interface.ts
• Re-export types in reexport.ts

Each Remix server runtime package MAY:

• Re-export the default implementations as its implementations
• Export custom implementations adhering to the interface types
• Provide additional exports relevant for that runtime