Prepare example codes for nextra v4 mdx compiling #1558
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive set of example codes to demonstrate the usage of the typia library across JSON schema validations, functional utilities, and LLM-based applications.
- Introduces new examples for JSON schema validations (assertParse, createAssertStringify, etc.).
- Adds functional examples demonstrating function validation and assertion.
- Provides LLM application examples including namespace, application, and service implementations.
Reviewed Changes
Copilot reviewed 68 out of 69 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/src/llm/namespace.ts | Defines an LLM application using a controller interface with documentation. |
| examples/src/llm/application.ts | Implements a basic LLM application example with ChatGPT. |
| examples/src/llm/application-separate.ts | Demonstrates schema separation for a Claude-based application. |
| examples/src/llm/IMember.ts | Provides IMember interface with typia tag validations. |
| examples/src/llm/IBbsArticle.ts | Defines article interfaces for a bulletin board system, with comments. |
| examples/src/llm/BbsArticleService.ts | Implements a service to handle article CRUD operations. |
| examples/src/json/schemas.ts | Provides a JSON schema example for member objects. |
| examples/src/json/schemas-type-tags.ts | Shows usage of custom type tags with placeholder messages. |
| examples/src/json/schemas-comment-tags.ts | Demonstrates JSON schema definitions using comment tags. |
| examples/src/json/isStringify.ts | Example of converting an object to a JSON string using typia. |
| examples/src/json/createIsParse.ts | Provides an example of creating a custom isParse function. |
| examples/src/json/createAssertStringify.ts | Demonstrates assertion and stringification for department objects. |
| examples/src/json/assertParse.ts | Example of asserting JSON parse results for member objects. |
| examples/src/functional/validateFunction.ts | Validates a given function using typia's functional utilities. |
| examples/src/functional/isFunction.ts | Checks if a provided function is valid using typia. |
| examples/src/functional/assertFunction.ts | Asserts function correctness with typia utility. |
Files not reviewed (1)
- examples/package.json: Language not supported
commit: |
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a set of new example code files and updates to demonstrate the usage of the
typialibrary. The changes include adding new JSON schema examples, functional examples, and LLM (Large Language Models) application examples. Below are the most important changes grouped by theme:JSON Schema Examples:
assertParse,createAssertStringify,createIsParse,isStringify,schemas-comment-tags,schemas-type-tags, andschemasexamples to demonstrate various JSON schema functionalities usingtypia(examples/src/json/assertParse.ts[1]examples/src/json/createAssertStringify.ts[2]examples/src/json/createIsParse.ts[3]examples/src/json/isStringify.ts[4]examples/src/json/schemas-comment-tags.ts[5]examples/src/json/schemas-type-tags.ts[6]examples/src/json/schemas.ts[7]).Functional Examples:
assertFunction,isFunction, andvalidateFunctionexamples to demonstrate functional programming with type assertions and validations usingtypia(examples/src/functional/assertFunction.ts[1]examples/src/functional/isFunction.ts[2]examples/src/functional/validateFunction.ts[3]).LLM Application Examples:
BbsArticleService,IBbsArticle,IMember,application-separate,application, andnamespaceexamples to demonstrate the integration oftypiawith LLM applications like ChatGPT and Claude (examples/src/llm/BbsArticleService.ts[1]examples/src/llm/IBbsArticle.ts[2]examples/src/llm/IMember.ts[3]examples/src/llm/application-separate.ts[4]examples/src/llm/application.ts[5]examples/src/llm/namespace.ts[6]).Configuration:
package.jsonfile in theexamplesdirectory to manage dependencies and scripts for building and running the examples (examples/package.json).