`nextAdminRouter` function

💡

This documentation covers an older version of Next Admin. If you are using the latest version (>=5.0.0 and above), please refer to the current documentation.

The following function should be used only for Pages Router.

nextAdminRouter is a function that returns a promise of a Node Router that you can use in your getServerSideProps function to start using Next Admin. Its usage is only related to Pages Router.

Usage example:

pages/api/admin/[[...nextadmin]].ts

export const getServerSideProps: GetServerSideProps = async ({ req, res }) => {
  const { nextAdminRouter } = await import(
    "@premieroctet/next-admin/dist/router"
  );
  const adminRouter = await nextAdminRouter(prisma, schema);
  return adminRouter.run(req, res) as Promise<
    GetServerSidePropsResult<{ [key: string]: any }>
  >;
};

It takes 3 parameters:

Your Prisma client instance, required
Your Prisma schema, required
and an optional object of type NextAdminOptions to customize your admin with the following properties:

import { NextAdminOptions } from "@premieroctet/next-admin";
 
const options: NextAdminOptions = {
  model: {
    User: {
      toString: (user) => `${user.email} / ${user.name}`,
    },
  },
};
 
const adminRouter = await nextAdminRouter(prisma, schema, options);

getPropsFromParams()Options parameter

nextAdminRouter function

`nextAdminRouter` function