Support header filtering for getRequestHeaders

[antoinerey]

Environment

h3@1.10.0
node@18.18.2

Reproduction

const headers = getRequestHeaders(event, ['host', 'cookie'])

const expected = { 
  host: '...', 
  cookie: '...', 
}

const actual = { 
  host: '...', 
  cookie: '...', 
  'accept-language': '...', 
  'user-agent': '...',
  // ... many more  
}

Describe the bug

When reading the README, the signature of getRequestHeaders looks like this:

getRequestHeaders(event, headers)

I believe the second parameter was originally meant to retrieve only a subset of all request headers, similar to the useRequestHeaders of Nuxt. However, that documented signature does not match the signature of the function implementation itself.

I believe that the original intent was good, and getRequestHeaders should accept a second parameter to pick whatever headers we want to retrieve. In brief, the following code should work as expected:

const headers = getRequestHeaders(event, ['host', 'cookie'])
//    ^? { host: '...', cookie: '...' }

Additional context

I'm open to creating a fix though.

Logs

No response

[pi0]

Please see reasonings in #620 (comment)

You might want to apply filtering directly on top of this method.

[antoinerey]

Got it. It makes sense. Thanks for the time! 🤗