Skip to content

Commit

Permalink
docs: explain difference between how to override Nextjs... constructs…
Browse files Browse the repository at this point in the history
… and lower level constructs
  • Loading branch information
bestickley committed Feb 2, 2025
1 parent 87cb81d commit 2c37f94
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ A: The `cdk-nextjs` package offers deep customization through _prop-based_ overr
Q: How can I use a custom domain with `cdk-nextjs`?
A: See [low-cost example](./examples/low-cost/app.ts).

Q: What is difference between `NextjsGlobalFunctionsProps.overrides.nextjsDistribution` and `NextjsGlobalFunctionsProps.overrides.nextjsGlobalFunctions.nextjsDistributionProps`
A: `NextjsGlobalFunctionsProps.overrides.nextjsDistribution` allows you to customize any construct's props _within_ `NextjsDistribution` and is likely what you want whereas `NextjsGlobalFunctionsProps.overrides.nextjsGlobalFunctions.nextjsDistributionProps` allows you to customize the props passed into the construct: `NextjsDistribution`. This principle also applies to other similarly named overrides.

## Acknowledgements

This construct was built on the shoulders of giants. Thank you to the contributors of [cdk-nextjs-standalone](https://github.com/jetbridge/cdk-nextjs) and [open-next](https://github.com/sst/open-next).
Expand Down

0 comments on commit 2c37f94

Please sign in to comment.