Why do we need `await` config in next.js server components?

evgeniyworkbel5 months ago

1 1

All examples/templates contain server nextjs components which await config. Are there problems if we won't await config?

• Selected Answer
  

  akhrarovsaid5 months ago

  Hey @evgeniyworkbel

  I don't think you need to await the config promise to be honest. Either way, it should work fine.

  More specifically, both getPayload and BasePayload.init will await the config as appropriate. If you await the config promise in advance of calling getPayload, then the behavior will be the same. The underlying code will await it anyway, and using await on a resolved promise or primitive value doesn't cause any negative consequences or overhead as far as I'm aware. It is safe.

  I'm adding a few links below, so that you may look through the code and explore what these functions do, and where exactly your config gets threaded through to in this process.

  • Config being awaited in BasePayload.init
  • The types for the InitOptions passed to getPayload, demonstrating that it can accept both a promise or config
  • Config being await in getPayload if necessary
  • Docs on using getPayload with an example that does not await the config promise