Skip to content

Commit 57f4fb6

Browse files
authored
chore: fix withPayload helper jsdoc (#12503)
<!-- Thank you for the PR! Please go through the checklist below and make sure you've completed all the steps. Please review the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository if you haven't already. The following items will ensure that your PR is handled as smoothly as possible: - PR Title must follow conventional commits format. For example, `feat: my new feature`, `fix(plugin-seo): my fix`. - Minimal description explained as if explained to someone not immediately familiar with the code. - Provide before/after screenshots or code diffs if applicable. - Link any related issues/discussions from GitHub or Discord. - Add review comments if necessary to explain to the reviewer the logic behind a change --> ### What? I found that the `devBundleServerPackages` parameter is not present in the documentation because it was spelled as `sortOnOptions`. ### Why? Cannot find `devBundleServerPackages` using vscode intellisense. ### How? I simply changed back `sortOnOptions` to `options` in JSDoc comments.
1 parent fcaf989 commit 57f4fb6

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

packages/next/src/withPayload.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @param {import('next').NextConfig} nextConfig
3-
* @param {Object} [sortOnOptions] - Optional configuration options
4-
* @param {boolean} [sortOnOptions.devBundleServerPackages] - Whether to bundle server packages in development mode. @default true
3+
* @param {Object} [options] - Optional configuration options
4+
* @param {boolean} [options.devBundleServerPackages] - Whether to bundle server packages in development mode. @default true
55
*
66
* @returns {import('next').NextConfig}
77
* */

0 commit comments

Comments
 (0)