Next.js getStaticProps() Function

Last Updated : 01 Feb, 2023

Data fetching in NextJS: To fetch the data from our own backend or using third-party APIs, we generally use client-side fetching using the fetch API provided by the browser. It fetches the data from the client-side on every request or browser reload. But NextJS provides us with better ways to fetch the data from the server. It gives us functions to pre-render our HTML on build time or request time. Those functions are

getServerSideProps: It renders the data at every request. It runs on the server-side and never on the browser.
getStaticProps: It helps generates the HTML page on the build time (when the code is deployed to production). It’s efficient for static data that changes less frequently.

Next.js getStaticProps() Function: It’s an async function that we export from the page component, used to generate data on the build time. It fetches the data and generates the HTML pages on our server and it caches it. So when we navigate to this page on our client-side, the cached HTML page is served directly to us, which is very useful for search engine optimization (SEO).

The code we write inside getStaticProps is safe and never runs on the browser. So we can also access our database using ORMs like Prisma inside this function as it runs on the server.

Steps to create a NextJS app.

Step 1: Run the following commands on terminal

npx create-next-app <your app name>
cd <your app folder>

Step 2: Open your project files on your desired code editor, and run the development server using this command

npm run dev

Now, navigate to https://localhost:3000 to preview

Project Structure: Also, your project folder should look like this,

index.js

JavaScript

export async function getStaticProps() {

  // Data fetching 
  return {
  
      // data added inside props will be 
    // received by page component as `props`
    props: {},
  };
}

We return an object from this function where we pass the `props` property with the data that you want to provide to the page component. When should we use getStaticProps?

When the data is not changing frequently like a blog website
Data that is coming from any content management system (CMS).
To get blazing fast, pre-rendered HTML and SEO friendly.

Let’s see how it works by fetching pokemon data from PokeAPI

Inside the pages folder of your project and in index.js, remove the previous line of code and create a page component and the getStaticProps function.

JavaScript

// Page Component, receiving allPokemons
// from getStaticProps
export default function Home({ allPokemons }) {
    return (
        <ul>
            { /* mapping all the data inside 
            an unordered list */}
            {allPokemons.map((poke) => (
                <li key={poke.url}>{poke.name}</li>
            ))}
        </ul>
    );
}

export async function getStaticProps() {

    // Call the fetch method and passing 
    // the pokeAPI link
    const response = await fetch(
        'https://pokeapi.co/api/v2/pokemon/');

    // Parse the JSON
    const data = await response.json();

    // Finally we return the result
    // inside props as allPokemons
    return {
        props: { allPokemons: data.results },
    };
}