fix(schema): fix router-options type

[wzc520pyfm]

🔗 Linked issue

📚 Description

The nuxt documentation states that history can return null or undefined, but this will cause a type error in the code.

Summary by CodeRabbit

• New Features
  • Enhanced flexibility of the history function to return null or undefined, allowing for better handling of various scenarios.

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[coderabbitai]

Walkthrough

The changes involve an update to the RouterOptions type in the packages/schema/src/types/router.ts file. The history property has been modified to allow for a more flexible return type, which now includes null and undefined in addition to RouterHistory. This change enhances the function's capability to handle a wider range of return scenarios without altering the existing logic or structure of the type.

Changes

File Path	Change Summary
packages/schema/src/types/router.ts	Updated history property in RouterOptions type to allow return type `RouterHistory

Suggested labels

3.x, bug

Suggested reviewers

• danielroe

Poem

In the code where rabbits hop,
A change was made, and we won't stop.
The history now can be null or not,
Flexibility's the name of the plot!
With every tweak, our paths align,
Hopping forward, all will be fine! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 204e241 and d2a8f99.

📒 Files selected for processing (1)

• packages/schema/src/types/router.ts (1 hunks)

🔇 Additional comments (1)

packages/schema/src/types/router.ts (1)

4-4: LGTM! Type definition now matches documented behavior.

The updated type definition correctly allows null and undefined return values for the history function, aligning with the documented behavior in Nuxt.

Let's verify the documentation claims about null/undefined returns:

✅ Verification successful

Type definition correctly matches documented behavior

The documentation in docs/2.guide/4.recipes/1.custom-routing.md explicitly states that the history function can return null or undefined, causing Nuxt to fallback to the default history. The updated type definition accurately reflects this documented behavior.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for documentation about history property return values
# Expected: Find documentation mentioning null/undefined returns for history

# Search in markdown files
rg -t md "history.*(\bnull\b|\bundefined\b)" 

# Search in TypeScript files for existing usage patterns
ast-grep --pattern 'history = $_ => null'
ast-grep --pattern 'history = $_ => undefined'

Length of output: 506

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[danielroe]

thank you!