Runtime Framework

Modern.js uses Hono.js as the BFF and Server runtime framework, so you can extend BFF Server based on the Hono.js ecosystem.

Getting Request Context

Sometimes in BFF functions, it's necessary to obtain the request context to handle more logic. In such cases, you can use useHonoContext to get it:

api/lambda/hello.ts

import { useHonoContext } from '@modern-js/plugin-bff/server';

export const get = async () => {
  const c = useHonoContext();
  console.info(`access url: ${c.req.url}`);
  return 'Hello Modern.js';
};

You can obtain the request context for a specific platform using env. For example, when deploying with Cloudflare Workers, you can obtain it using bindings:

api/lambda/hello.ts

import { useHonoContext } from '@modern-js/plugin-bff/server';

export const get = async () => {
  const c = useHonoContext();
  const data = await c.env.NAMESPACE.get("key");
  console.info(`storage data: ${data}`);
  return 'Hello Modern.js';
};

Info

For more details, refer to useHonoContext.

Defining BFF Functions

When using Hono as the runtime framework, you can define interfaces through BFF Functions:

api/lambda/user.ts

import { Api, Get, Query } from '@modern-js/plugin-bff/server';
import { z } from 'zod';

const QuerySchema = z.object({
  id: z.string(),
});

export const getUser = Api(
  Get('/user'),
  Query(QuerySchema),
  async ({ query }) => {
    return {
      id: query.id,
      name: 'Modern.js',
      email: 'modernjs@bytedance.com',
    };
  },
);

Using Middleware

Hono supports a rich middleware ecosystem, and you can use middleware in BFF functions:

api/lambda/user.ts

import { Api, Get, Middleware } from '@modern-js/plugin-bff/server';

export const getUser = Api(
  Get('/user'),
  Middleware(async (c, next) => {
    // You can access Hono's Context in middleware
    c.res.headers.set('X-Powered-By', 'Modern.js');
    await next();
  }),
  async () => {
    return {
      name: 'Modern.js',
      email: 'modernjs@bytedance.com',
    };
  },
);

Runtime Framework

Getting Request Context

Defining BFF Functions

Using Middleware

More Hono Documentation

Runtime Framework

Getting Request Context

Defining BFF Functions

Using Middleware

More Hono Documentation

#Runtime Framework

#Getting Request Context

#Defining BFF Functions

#Using Middleware

#More Hono Documentation

#Runtime Framework

#Getting Request Context

#Defining BFF Functions

#Using Middleware

#More Hono Documentation

Runtime Framework

Getting Request Context

Defining BFF Functions

Using Middleware

More Hono Documentation

Runtime Framework

Getting Request Context

Defining BFF Functions

Using Middleware

More Hono Documentation