📚 Doc: Fix static middleware CacheDuration data type typo

[grivera64]

Description

There is a typo of the data type of the field CacheDuration. On docs.gofiber.io, the CacheDuration type is string, when the actual code says time.Duration.

This PR fixes the typo in the docs by changing the data type for CacheDuration to time.Duration as it is in the code from above.

Fixes #3272

Changes introduced

• Benchmarks: Describe any performance benchmarks and improvements related to the changes.
• Documentation Update: Detail the updates made to the documentation and links to the changed files.
• Changelog/What's New: Include a summary of the additions for the upcoming release notes.
• Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
• API Alignment with Express: Explain how the changes align with the Express API.
• API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
• Examples: Provide examples demonstrating the new features or changes in action.

Type of change

• Documentation update (changes to documentation)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

• Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
• Conducted a self-review of the code and provided comments for complex or critical parts.
• Updated the documentation in the /docs/ directory for Fiber's documentation.
• Added or updated unit tests to validate the effectiveness of the changes or new features.
• Ensured that new and existing unit tests pass locally with the changes.
• Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
• Aimed for optimal performance with minimal allocations in the new code.
• Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

[coderabbitai]

Walkthrough

The pull request updates the documentation for the Fiber static middleware, specifically correcting the type of the CacheDuration configuration property from string to time.Duration. This change aligns the documentation with the actual implementation in the codebase, ensuring accurate representation of the middleware's configuration. The documentation maintains its original structure while providing clearer guidance on how to specify cache durations.

Changes

File	Change Summary
docs/middleware/static.md	Updated CacheDuration type documentation from string to time.Duration

Assessment against linked issues

Objective	Addressed	Explanation
Fix static middleware config typo in docs [#3272]	✅

Possibly related PRs

• chore(middleware/cache): fix typo #3145: Changes to cache-related comments
• 📚 Doc: Update intro documentation #3204: Improvements to documentation structure

Suggested labels

📒 Documentation, ☢️ Bug

Suggested reviewers

• sixcolors
• gaby
• efectn
• ReneWerner87

Poem

🐰 A rabbit hops through docs so bright,
Fixing types with coding might,
From string to Duration's grace,
Middleware docs now find their place!
Documentation's clarity shines ✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5355869 and abd232f.

📒 Files selected for processing (1)

• docs/middleware/static.md (1 hunks)

🔇 Additional comments (1)

docs/middleware/static.md (1)

157-157: LGTM! Documentation accurately reflects the implementation.

The type correction from string to time.Duration aligns with the actual implementation and provides clearer guidance for users.

Let's verify this matches the actual implementation:

✅ Verification successful

Documentation accurately reflects the implementation of CacheDuration

The verification confirms that:

• The field is correctly defined as time.Duration in the Config struct
• The implementation comments match the documentation:
  • Same default value: "10 * time.Second"
  • Same behavior for negative values: "Use a negative time.Duration to disable it"

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify CacheDuration type in the actual implementation
# Expected: CacheDuration field should be of type time.Duration

# Search for CacheDuration field definition in Config struct
ast-grep --pattern 'type Config struct {
  $$$
  CacheDuration time.Duration
  $$$
}'

Length of output: 3665

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.