What is the proper way to get payload?

awfaaraxlast year

14

import { getPayload } from 'payload'
import config from '@payload-config'

const payload = await getPayload({ config })

import payload from "payload"

• 

  zed0547last year

  This will not work

  import payload from "payload"
  
  

  You should proceed with your first example

  
  
  

  It will give you a BasePayload instance that is not practically useful for you as it wasn't initialized at that point

• 

  kaspartrlast year

  This approach breaks my production:

  
  

  Error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error

• 

  zed0547last year

  Dude you use get Payload in a client component?

• 

  kaspartrlast year

  Inside a collection hook. What other way to access local API in collection hook is there.

  
  
  

  Colletion -> Hook -> LocalApi

• 

  zed0547last year

  Well you wouldn't use getPayload there, you would access the Payload instance directly through req:

  req.payload
• 

  kaspartrlast year

  Collection -> Hook -req.payload -> LocalApi (use payload in argument)?

  
  
  

  But this apporach works in another payload project. So onfusing. It's in production and working.

• 

  zed0547last year

  Every hook gets passed a req, you can access the local api through the Payload instance there yes.

  
  
  

  Not sure, but it might be due to import paths or resolution

  
  
  

  But it's redundant to call getPayload anywhere outside of the frontend tbh

  
  
  

  Everywhere else you can access it via req

• 

  kaspartrlast year

  I understand its reduntant, but how come it works locally but is completely broken in production deployment?

• 

  rilromlast year

  Could be any number of reasons. It wasn’t intended to be used in this way so it’s expected there would be quirks.

• 

  kaspartrlast year

  I am a little bit confused. The newes documentation clearly states the way to import payload.

  
  https://payloadcms.com/docs/local-api/overview#accessing-payload
  
  

  import { getPayload } from 'payload'
  import config from '@payload-config'
  
  const payload = await getPayload({ config })

  
  
  

  But this only works locally and not in production then?

• 

  rilromlast year

  The documentation says if you don’t have access to payload in either function arguments or the req object then you can do it that way.

  
  
  

  getPayload works both locally and in production when used properly.

• 

  kaspartrlast year

  I guess then the question becomes how to use it properly. I understand that I cannot use it as documented if it is used by the front-end although in the docs it explicilty sayd it doesn't matter?

• 

  rilromlast year

  You mentioned above it’s for a collection hook. In this case you would access payload using req.payload

• 

  zed0547last year

  I understand that I cannot use it as documented if it is used by the front-end
  

  This was misinterpreted from what I said I think.

  
  
  

  Usage of local api:

  
  

  Hooks, Access Controls, Custom Endpoints, Anywhere else you have access to

  req

  automatically -> use

  req.payload
  
  

  Areas where you do not have access to a Payload request

  req

  object, such as in the pages of your frontend app ->

  getPayload
  
  

  The documentation states this too.