nitrojs / nitrojs/nitro

Expose matching route meta in event handler

Open
#4,275 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement v2 v3
Dominant language
TypeScript
Stars
11.2k
Forks
899
Avg merge
2d 24m
Merged PRs (30d)
40

Description

Describe the feature

Hello! I'm not sure this is a bug, but definitely something I need. I'm using defineRouteMeta to add documentation around some endpoints. Those endpoint are being protected using an ApiKey, AND a scope.
I do need a way to access the matched route meta from a middleware in order to check the matched route scope expectations against scope allowed by the api key. If I do have access to the latest, I'm struggling to find a way to read route metas from the middleware itself.
My proposal is simply to add event.meta.
Thoughts?

Additional information
  • Would you be willing to help implement this feature?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how defineRouteMeta data is attached to matched routes and how middleware receives the event. Check whether the matched route metadata is already available at the event-handler entry point. Done means middleware can read the matched route's metadata through event.meta, with coverage for checking endpoint scope expectations against an API key.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
66/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.