next-runtime
    TypeScript icon, indicating that this package has built-in type declarations

    2.4.0 • Public • Published

    banner

    All you need to handle POST requests and file uploads in getServerSideProps.

    Documentation

    All documentation and guides can be found at next-runtime.meijer.ws.

    Features

    next-runtime aims to move more logic to the "runtime part" of your Next.js server, and less static site generation. With proper cache headers, every server is an (incremental) static site generator.

    To achieve that, we provide you a convenient API to:

    • Handle POST requests in getServerSideProps.
    • Handle file uploads in getServerSideProps.
    • Easily manage headers and cookies.
    • Reuse getServerSideProps as zero-config JSON api.

    Usage

    In case you're not the documentation type of person, here's a quick example to get you up and running. Please consult the docs if this leaves you with questions.

    import fs from 'fs';
    import { handle, json } from 'next-runtime';
    
    export const getServerSideProps = handle({
      async upload({ file, stream }) {
        stream.pipe(fs.createWriteStream(`/uploads/${file.name}`));
      },
    
      async get({ params, query }) {
        return json({ name: 'Stephan Meijer' });
      },
    
      async post({ req: { body } }) {
        return json({ message: 'Thanks for your submission!' });
      },
    });
    
    export default function Home({ name, message }) {
      if (message) {
        return <p>{message}</p>;
      }
    
      return (
        <form method="post" encType="multipart/form-data">
          <input name="name" defaultValue={name} />
          <input type="file" name="file" />
          <button type="submit">submit</button>
        </form>
      );
    }

    Sponsor

    Are you, or your employer, a satisfied user of this, or any of my other projects. Then please consider sponsoring my work so I can dedicate more time to maintaining this kind of projects.

    Contributing

    Please check contributing.md. It contains info about the structure of this repo to help you get up and running.

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Stephan Meijer

    💻 📖 🤔 🚇 🚧

    Gal Schlezinger

    📖

    Darius

    💻 ⚠️

    Umar Ahmed

    💻

    HIKARU KOBORI

    💻

    Koichi Kiyokawa

    💻 ⚠️

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Keywords

    none

    Install

    npm i next-runtime

    DownloadsWeekly Downloads

    481

    Version

    2.4.0

    License

    MIT

    Unpacked Size

    1.45 MB

    Total Files

    134

    Last publish

    Collaborators

    • smeijer