Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
neg4n committed Apr 6, 2022
1 parent 9b825f3 commit 138e967
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,14 @@ Example configuration with **default values** _(apart from template.html or temp
const nextApiOgImageConfig = {
// Values passing strategy
strategy: 'query',
// 'Content-Type' HTTP header
contentType: 'image/png',
// Width of the image in pixels (default 1200)
width: 2048,
// Height of the image in pixels (default 630)
height: 1170,
// Response's 'Content-Type' HTTP header and browser screenshot type.
type: 'png',
// Screenshot's quality. WORKS ONLY IF 'type' IS SET TO 'jpeg'
quality: 90,
// Width of the image in pixels
width: 1200,
// Height of the image in pixels
height: 630,
// 'Cache-Control' HTTP header
cacheControl: 'max-age 3600, must-revalidate',
// NOTE: Options within 'dev' object works only when process.env.NODE_ENV === 'development'
Expand Down

0 comments on commit 138e967

Please sign in to comment.