docs: type utility

[dinwwwh]

Summary by CodeRabbit

• Documentation
  • Introduced a new section describing the built-in type utility for input and output validation.
  • Provided an example to demonstrate its use as an alternative to external validation libraries.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
orpc	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 28, 2025 2:51am

[coderabbitai]

Walkthrough

A new section titled type Utility was added to the documentation in apps/content/docs/procedure.md. The section explains how to use oRPC's built-in type utility for input and output validation without relying on external libraries. An example accompanying the section demonstrates importing the type utility (and os) from the @orpc/server package, defining an input type with a numeric value property, and returning that value as the output.

Changes

File	Change Summary
apps/.../procedure.md	Added a new section "type Utility" with an example demonstrating the built-in type utility for input/output validation.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Procedure
    participant TypeUtility

    Client->>Procedure: Submit input object { value: number }
    Procedure->>TypeUtility: Validate input using type utility
    TypeUtility-->>Procedure: Return validated input or error
    Procedure->>Procedure: Process input to produce output
    Procedure->>TypeUtility: Validate output type
    TypeUtility-->>Procedure: Return validated output
    Procedure-->>Client: Send output value

Loading

Poem

Hopping through docs in the moonlit night,
I found a utility shining bright.
With types to check and values to share,
My code now leaps without a care.
From rabbit paws, cheers to the code delight!
🐇✨

---

🪧 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.
• @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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[pkg-pr-new]

Open in Stackblitz

More templates

• orpc-contract-openapi-playground
• orpc-expresjs-playground
• orpc-nextjs-playground
• orpc-nuxt-playground
• orpc-openapi-playground

@orpc/client

npm i https://pkg.pr.new/@orpc/client@178

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@178

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@178

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@178

@orpc/server

npm i https://pkg.pr.new/@orpc/server@178

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@178

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@178

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@178

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@178

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@178

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@178

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@178

commit: b63d12a

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

apps/content/docs/procedure.md (2)

40-42: New Section Header and Introduction for type Utility

The newly added section header and introductory text clearly explain the purpose of the built-in type utility and when it might be useful as a lightweight alternative to external libraries. Consider adding a brief note about typical use cases or limitations to provide even more context for readers.

---

44-51: Code Example for Demonstrating type Utility Usage

The provided TypeScript code snippet effectively demonstrates how to import and use both os and the type utility from the @orpc/server package. The usage of generic parameters for both the input and output validations is clear and well illustrated. Optionally, you might consider adding inline comments within the snippet to explain:

• What the generic type parameter in .input(type<{ value: number }>()) represents.
• How the mapping function in .output(type<{ value: number }, number>(({ value }) => value)) transforms the input into the output.

This can help users quickly grasp the data flow in the procedure without referring back to separate documentation.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b2e67f7 and b63d12a.

📒 Files selected for processing (1)

• apps/content/docs/procedure.md (1 hunks)