feat: deprecates getPayloadHMR in favor of simpler getPayload (#9249)
Deprecates `getPayloadHMR` and simplifies this pattern into a single
`import { getPayload } from 'payload'`.
We will still retain the exported `getPayloadHMR` but it now will throw
a deprecation warning with instructions for how to migrate.
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
import type { CollectionSlug, Where } from 'payload'
|
||||
|
||||
import config from '@payload-config'
|
||||
import { getPayloadHMR } from '@payloadcms/next/utilities/getPayloadHMR.js'
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
export const getDoc = async <T>(args: {
|
||||
collection: CollectionSlug
|
||||
@@ -9,7 +9,7 @@ export const getDoc = async <T>(args: {
|
||||
draft?: boolean
|
||||
slug?: string
|
||||
}): Promise<T> => {
|
||||
const payload = await getPayloadHMR({ config })
|
||||
const payload = await getPayload({ config })
|
||||
const { slug, collection, depth = 2, draft } = args || {}
|
||||
|
||||
const where: Where = {}
|
||||
@@ -28,7 +28,9 @@ export const getDoc = async <T>(args: {
|
||||
draft,
|
||||
})
|
||||
|
||||
if (docs[0]) return docs[0] as T
|
||||
if (docs[0]) {
|
||||
return docs[0] as T
|
||||
}
|
||||
} catch (err) {
|
||||
console.log('Error getting doc', err)
|
||||
}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import config from '@payload-config'
|
||||
import { getPayloadHMR } from '@payloadcms/next/utilities/getPayloadHMR.js'
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
export const getDocs = async <T>(collection: string): Promise<T[]> => {
|
||||
const payload = await getPayloadHMR({ config })
|
||||
const payload = await getPayload({ config })
|
||||
|
||||
try {
|
||||
const { docs } = await payload.find({
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
import config from '@payload-config'
|
||||
import { getPayloadHMR } from '@payloadcms/next/utilities/getPayloadHMR.js'
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
import type { Footer } from '../../../payload-types.js'
|
||||
|
||||
export async function getFooter(): Promise<Footer> {
|
||||
const payload = await getPayloadHMR({ config })
|
||||
const payload = await getPayload({ config })
|
||||
|
||||
try {
|
||||
const footer = await payload.findGlobal({
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
import config from '@payload-config'
|
||||
import { getPayloadHMR } from '@payloadcms/next/utilities/getPayloadHMR.js'
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
import type { Header } from '../../../payload-types.js'
|
||||
|
||||
export async function getHeader(): Promise<Header> {
|
||||
const payload = await getPayloadHMR({ config })
|
||||
const payload = await getPayload({ config })
|
||||
|
||||
try {
|
||||
const header = await payload.findGlobal({
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import type { CollectionSlug, Where } from 'payload'
|
||||
|
||||
import config from '@payload-config'
|
||||
import { getPayloadHMR } from '@payloadcms/next/utilities/getPayloadHMR.js'
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
export const getDoc = async <T>(args: {
|
||||
collection: CollectionSlug
|
||||
@@ -9,7 +9,7 @@ export const getDoc = async <T>(args: {
|
||||
draft?: boolean
|
||||
slug?: string
|
||||
}): Promise<T> => {
|
||||
const payload = await getPayloadHMR({ config })
|
||||
const payload = await getPayload({ config })
|
||||
const { slug, collection, depth = 2, draft } = args || {}
|
||||
|
||||
const where: Where = {}
|
||||
@@ -28,7 +28,9 @@ export const getDoc = async <T>(args: {
|
||||
draft,
|
||||
})
|
||||
|
||||
if (docs[0]) return docs[0] as T
|
||||
if (docs[0]) {
|
||||
return docs[0] as T
|
||||
}
|
||||
} catch (err) {
|
||||
console.log('Error getting doc', err)
|
||||
}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import config from '@payload-config'
|
||||
import { getPayloadHMR } from '@payloadcms/next/utilities/getPayloadHMR.js'
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
export const getDocs = async <T>(collection: string): Promise<T[]> => {
|
||||
const payload = await getPayloadHMR({ config })
|
||||
const payload = await getPayload({ config })
|
||||
|
||||
try {
|
||||
const { docs } = await payload.find({
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
import config from '@payload-config'
|
||||
import { getPayloadHMR } from '@payloadcms/next/utilities/getPayloadHMR.js'
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
import type { Footer } from '../../../../payload-types.js'
|
||||
|
||||
export async function getFooter(): Promise<Footer> {
|
||||
const payload = await getPayloadHMR({ config })
|
||||
const payload = await getPayload({ config })
|
||||
|
||||
try {
|
||||
const footer = await payload.findGlobal({
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
import config from '@payload-config'
|
||||
import { getPayloadHMR } from '@payloadcms/next/utilities/getPayloadHMR.js'
|
||||
import { getPayload } from 'payload'
|
||||
|
||||
import type { Header } from '../../../../payload-types.js'
|
||||
|
||||
export async function getHeader(): Promise<Header> {
|
||||
const payload = await getPayloadHMR({ config })
|
||||
const payload = await getPayload({ config })
|
||||
|
||||
try {
|
||||
const header = await payload.findGlobal({
|
||||
|
||||
Reference in New Issue
Block a user