Runtime API Examples
This page demonstrates usage of some of the runtime APIs provided by VitePress.
The main useData() API can be used to access site, theme, and page data for the current page. It works in both .md and .vue files:
md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>Results
Theme Data
{
"logo": {
"src": "/images/vb6.pro-logo-32x32.png",
"width": 24,
"height": 24
},
"socialLinks": [
{
"icon": "googlehome",
"link": "http://a-vi.com"
},
{
"icon": "rocketdotchat",
"link": "https://chat.vb6.pro/"
}
],
"search": {
"provider": "local",
"options": {
"translations": {
"button": {
"buttonText": "全局搜索...",
"buttonAriaLabel": "搜索"
},
"modal": {
"noResultsText": "无法找到相关结果",
"resetButtonTitle": "清除查询条件",
"footer": {
"selectText": "选择",
"navigateText": "切换",
"closeText": "关闭"
}
}
}
}
},
"nav": [
{
"text": "下载",
"link": "/"
},
{
"text": "VBMAN",
"link": "/vbman/"
},
{
"text": "VBMAN2",
"link": "/vbman2/"
},
{
"text": "捐赠",
"link": "/donate/"
},
{
"text": "致谢",
"link": "/CREDITS"
},
{
"text": "加群",
"link": "http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=maQtC3a5Zxb3gMLvwpj6oE5fwmZGCOlY&authKey=8%2FhBgSMLqADLatzXghFXO5BIBa%2BxSoHO%2FHFvtbZQk2kURUx%2FegxZukzAvhSPX6WJ&noverify=0&group_code=915520648"
},
{
"text": "商业化",
"items": [
{
"text": "网络验证框架",
"link": "/biz/cs-auther/"
}
]
},
{
"text": "更多",
"items": [
{
"text": "旧版文档",
"link": "https://doc0.vb6.pro/"
},
{
"text": "博客",
"link": "https://vb6.pro/"
},
{
"text": "联系我们",
"link": "/CONTACT"
}
]
}
],
"outline": {
"level": "deep",
"label": "页内目录"
},
"sidebar": {
"/vbccr/": [
{
"text": "VBCCR 控件",
"items": [
{
"text": "介绍",
"link": "/vbccr/"
},
{
"text": "动画控件",
"link": "/vbccr/animation"
},
{
"text": "复选框控件",
"link": "/vbccr/checkbox"
},
{
"text": "组合框控件",
"link": "/vbccr/combobox"
},
{
"text": "命令按钮控件",
"link": "/vbccr/commandbutton"
},
{
"text": "命令链接控件",
"link": "/vbccr/commandlink"
},
{
"text": "通用对话框控件",
"link": "/vbccr/commondialog"
},
{
"text": "工具条控件",
"link": "/vbccr/coolbar"
},
{
"text": "日期时间选择器控件",
"link": "/vbccr/dtpicker"
},
{
"text": "字体组合框控件",
"link": "/vbccr/fontcombo"
},
{
"text": "框架控件",
"link": "/vbccr/frame"
},
{
"text": "热键控件",
"link": "/vbccr/hotkey"
},
{
"text": "图像组合框控件",
"link": "/vbccr/imagecombo"
},
{
"text": "图像列表控件",
"link": "/vbccr/imagelist"
},
{
"text": "IP地址控件",
"link": "/vbccr/ipaddress"
},
{
"text": "标签控件",
"link": "/vbccr/label"
},
{
"text": "链接标签控件",
"link": "/vbccr/linklabel"
},
{
"text": "列表框控件",
"link": "/vbccr/listbox"
},
{
"text": "列表视图控件",
"link": "/vbccr/listview"
},
{
"text": "多媒体控件",
"link": "/vbccr/mciwnd"
},
{
"text": "月视图控件",
"link": "/vbccr/monthview"
},
{
"text": "选项按钮控件",
"link": "/vbccr/optionbutton"
},
{
"text": "分页控件",
"link": "/vbccr/pager"
},
{
"text": "进度条控件",
"link": "/vbccr/progressbar"
},
{
"text": "富文本框控件",
"link": "/vbccr/richtextbox"
},
{
"text": "滑块控件",
"link": "/vbccr/slider"
},
{
"text": "数字调节框控件",
"link": "/vbccr/spinbox"
},
{
"text": "状态栏控件",
"link": "/vbccr/statusbar"
},
{
"text": "系统信息控件",
"link": "/vbccr/sysinfo"
},
{
"text": "选项卡控件",
"link": "/vbccr/tabstrip"
},
{
"text": "文本框控件",
"link": "/vbccr/textbox"
},
{
"text": "工具栏控件",
"link": "/vbccr/toolbar"
},
{
"text": "树形视图控件",
"link": "/vbccr/treeview"
},
{
"text": "上下调节控件",
"link": "/vbccr/updown"
},
{
"text": "虚拟组合框控件",
"link": "/vbccr/virtualcombo"
},
{
"text": "虚拟列表框控件",
"link": "/vbccr/vlistbox"
},
{
"text": "窗口化标签控件",
"link": "/vbccr/windowedlabel"
},
{
"text": "官方文档",
"link": "/vbccr/readme"
}
]
}
],
"/vbman/": [
{
"text": "VBMAN 文档",
"items": [
{
"text": "介绍",
"link": "/vbman/"
},
{
"text": "致谢",
"link": "/vbman/CREDITS"
},
{
"text": "日志",
"link": "/vbman/start/devlog"
},
{
"text": "Winsock",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/winsock/overview"
},
{
"text": "事件详解",
"link": "/vbman/winsock/events"
},
{
"text": "属性参考",
"link": "/vbman/winsock/properties"
},
{
"text": "方法参考",
"link": "/vbman/winsock/methods"
},
{
"text": "编码指南",
"link": "/vbman/winsock/encoding"
},
{
"text": "TCP编程",
"link": "/vbman/winsock/tcp"
},
{
"text": "UDP编程",
"link": "/vbman/winsock/udp"
},
{
"text": "最佳实践",
"link": "/vbman/winsock/best-practices"
},
{
"text": "性能压力测试",
"link": "/vbman/winsock/benchmarks"
},
{
"text": "开发计划",
"link": "/vbman/winsock/roadmap"
},
{
"text": "同步方法",
"link": "/vbman/winsock/sync-methods"
}
]
},
{
"text": "Json",
"collapsed": false,
"items": [
{
"text": "介绍",
"link": "/vbman/Json/index"
},
{
"text": "快速开始",
"link": "/vbman/Json/quickstart"
},
{
"text": "API 参考",
"link": "/vbman/Json/api-reference"
},
{
"text": "示例代码",
"link": "/vbman/Json/examples"
},
{
"text": "最佳实践",
"link": "/vbman/Json/best-practices"
},
{
"text": "常见问题",
"link": "/vbman/Json/faq"
}
]
},
{
"text": "WebSocket",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/websocket/overview"
},
{
"text": "类库总览",
"link": "/vbman/websocket/library"
},
{
"text": "客户端类",
"link": "/vbman/websocket/client"
},
{
"text": "服务端类",
"link": "/vbman/websocket/server"
},
{
"text": "帧解析类",
"link": "/vbman/websocket/frame"
},
{
"text": "字节缓冲区类",
"link": "/vbman/websocket/buffer"
},
{
"text": "工具模块",
"link": "/vbman/websocket/utils"
},
{
"text": "快速开始",
"link": "/vbman/websocket/quickstart"
},
{
"text": "进阶应用",
"link": "/vbman/websocket/advanced"
}
]
},
{
"text": "Redis",
"collapsed": false,
"items": [
{
"text": "介绍",
"link": "/vbman/redis/README"
},
{
"text": "连接管理",
"link": "/vbman/redis/connection"
},
{
"text": "基础命令",
"link": "/vbman/redis/basic-operations"
},
{
"text": "String 操作",
"link": "/vbman/redis/string-operations"
},
{
"text": "Hash 操作",
"link": "/vbman/redis/hash-operations"
},
{
"text": "List 操作",
"link": "/vbman/redis/list-operations"
},
{
"text": "Set 操作",
"link": "/vbman/redis/set-operations"
},
{
"text": "Sorted Set 操作",
"link": "/vbman/redis/sorted-set-operations"
},
{
"text": "事务操作",
"link": "/vbman/redis/transaction"
},
{
"text": "完整示例",
"link": "/vbman/redis/examples"
}
]
},
{
"text": "数据库",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/database/index"
},
{
"text": "快速开始",
"link": "/vbman/database/quickstart"
},
{
"text": "连接管理",
"link": "/vbman/database/connection"
},
{
"text": "执行命令",
"link": "/vbman/database/execute"
},
{
"text": "查询数据",
"link": "/vbman/database/query"
},
{
"text": "参数化查询",
"link": "/vbman/database/parameterized"
},
{
"text": "分页查询",
"link": "/vbman/database/pagination"
},
{
"text": "事务处理",
"link": "/vbman/database/transaction"
},
{
"text": "高级功能",
"link": "/vbman/database/advanced"
},
{
"text": "工具函数",
"link": "/vbman/database/utilities"
}
]
},
{
"text": "Modbus",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/modbus/overview"
},
{
"text": "快速开始",
"link": "/vbman/modbus/quickstart"
},
{
"text": "主站模式",
"link": "/vbman/modbus/master"
},
{
"text": "从站模式",
"link": "/vbman/modbus/slave"
},
{
"text": "高级应用",
"link": "/vbman/modbus/advanced"
}
]
},
{
"text": "示例",
"collapsed": false,
"items": [
{
"text": "Hello World",
"link": "/vbman/demo/1.HelloWorld"
},
{
"text": "Web 根目录",
"link": "/vbman/demo/2.Webroot"
},
{
"text": "数据库",
"link": "/vbman/demo/3.Database"
},
{
"text": "JSON",
"link": "/vbman/demo/4.cJson"
},
{
"text": "中间件",
"link": "/vbman/demo/5.MiddleWare"
},
{
"text": "SSE",
"link": "/vbman/demo/6.SSE"
},
{
"text": "SSE2",
"link": "/vbman/demo/7.SSE2"
},
{
"text": "WebSocket",
"link": "/vbman/demo/8.WebSocket"
},
{
"text": "API调用",
"link": "/vbman/demo/9.ApiCall"
},
{
"text": "多进程",
"link": "/vbman/demo/10.Multiprocessor"
},
{
"text": "网络数据展示",
"link": "/vbman/demo/11.NetDataShow"
},
{
"text": "后台管理",
"link": "/vbman/demo/12.AdminEnd"
},
{
"text": "天气预报",
"link": "/vbman/demo/13.Weather"
},
{
"text": "Winsock",
"link": "/vbman/demo/14.Winsock"
},
{
"text": "WebSocket",
"link": "/vbman/demo/15.Websocket"
}
]
},
{
"text": "Toast",
"collapsed": false,
"items": [
{
"text": "概述",
"link": "/vbman/Toast/"
},
{
"text": "API 参考",
"link": "/vbman/Toast/api"
},
{
"text": "使用示例",
"link": "/vbman/Toast/examples"
},
{
"text": "技术细节",
"link": "/vbman/Toast/technical"
},
{
"text": "常见问题",
"link": "/vbman/Toast/faq"
}
]
},
{
"text": "HttpClient",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/httpclient/overview"
},
{
"text": "方法参考",
"link": "/vbman/httpclient/methods"
},
{
"text": "属性参考",
"link": "/vbman/httpclient/properties"
},
{
"text": "SSE客户端",
"link": "/vbman/httpclient/sse"
}
]
},
{
"text": "HttpServer",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/httpserver/overview"
},
{
"text": "请求",
"link": "/vbman/httpserver/request"
},
{
"text": "响应",
"link": "/vbman/httpserver/response"
},
{
"text": "路由",
"link": "/vbman/httpserver/router"
},
{
"text": "中间件",
"link": "/vbman/httpserver/middleware"
},
{
"text": "会话",
"link": "/vbman/httpserver/session"
},
{
"text": "Cookie",
"link": "/vbman/httpserver/cookie"
},
{
"text": "上下文",
"link": "/vbman/httpserver/context"
},
{
"text": "安全",
"link": "/vbman/httpserver/security"
},
{
"text": "数据库",
"link": "/vbman/httpserver/database"
},
{
"text": "静态文件",
"link": "/vbman/httpserver/static-files"
},
{
"text": "SSE服务端",
"link": "/vbman/httpserver/sse-server"
}
]
},
{
"text": "Crypt",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/crypt/overview"
},
{
"text": "AES",
"collapsed": true,
"items": [
{
"text": "总览",
"link": "/vbman/crypt/aes/overview"
},
{
"text": "方法参考",
"link": "/vbman/crypt/aes/methods"
}
]
},
{
"text": "Hash",
"collapsed": true,
"items": [
{
"text": "总览",
"link": "/vbman/crypt/hash/overview"
},
{
"text": "方法参考",
"link": "/vbman/crypt/hash/methods"
}
]
},
{
"text": "HMAC",
"collapsed": true,
"items": [
{
"text": "总览",
"link": "/vbman/crypt/hmac/overview"
},
{
"text": "方法参考",
"link": "/vbman/crypt/hmac/methods"
}
]
}
]
},
{
"text": "Collection",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/collection/overview"
},
{
"text": "属性参考",
"link": "/vbman/collection/properties"
},
{
"text": "方法参考",
"link": "/vbman/collection/methods"
}
]
},
{
"text": "Logs",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/logs/overview"
},
{
"text": "属性参考",
"link": "/vbman/logs/properties"
},
{
"text": "方法参考",
"link": "/vbman/logs/methods"
}
]
},
{
"text": "Dialog",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/dialog/overview"
},
{
"text": "属性参考",
"link": "/vbman/dialog/properties"
},
{
"text": "方法参考",
"link": "/vbman/dialog/methods"
}
]
},
{
"text": "Delay",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/delay/overview"
},
{
"text": "属性参考",
"link": "/vbman/delay/properties"
},
{
"text": "方法参考",
"link": "/vbman/delay/methods"
},
{
"text": "为什么需要Delay",
"link": "/vbman/delay/whyDelay"
},
{
"text": "自述",
"link": "/vbman/delay/readme"
},
{
"text": "TODO",
"link": "/vbman/delay/TODO"
}
]
},
{
"text": "Startup",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/startup/overview"
},
{
"text": "属性参考",
"link": "/vbman/startup/properties"
},
{
"text": "方法参考",
"link": "/vbman/startup/methods"
}
]
},
{
"text": "Stdio",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/stdio/overview"
},
{
"text": "方法参考",
"link": "/vbman/stdio/methods"
},
{
"text": "示例",
"link": "/vbman/stdio/examples"
}
]
},
{
"text": "QRCode",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/qrcode/overview"
},
{
"text": "方法参考",
"link": "/vbman/qrcode/methods"
}
]
},
{
"text": "PLI",
"collapsed": false,
"items": [
{
"text": "总览",
"link": "/vbman/pli/overview"
},
{
"text": "方法参考",
"link": "/vbman/pli/methods"
}
]
},
{
"text": "Tools",
"collapsed": false,
"items": [
{
"text": "自述",
"link": "/vbman/tools/README"
},
{
"text": "数组",
"link": "/vbman/tools/array"
},
{
"text": "Base64",
"link": "/vbman/tools/base64"
},
{
"text": "日期时间",
"link": "/vbman/tools/datetime"
},
{
"text": "字典",
"link": "/vbman/tools/dic"
},
{
"text": "FSO",
"link": "/vbman/tools/fso"
},
{
"text": "HTTP",
"link": "/vbman/tools/http"
},
{
"text": "数学",
"link": "/vbman/tools/math"
},
{
"text": "密码",
"link": "/vbman/tools/password"
},
{
"text": "字符串",
"link": "/vbman/tools/string"
},
{
"text": "系统",
"link": "/vbman/tools/system"
},
{
"text": "UTF8",
"link": "/vbman/tools/utf8"
},
{
"text": "窗口",
"link": "/vbman/tools/window"
}
]
}
]
}
],
"/vbman2/": [
{
"text": "VBMAN2 文档",
"items": [
{
"text": "介绍",
"link": "/vbman2/index"
},
{
"text": "致谢",
"link": "/vbman2/CREDITS"
},
{
"text": "已知问题",
"link": "/vbman2/start/issus"
},
{
"text": "核心功能",
"link": "/vbman2/core"
},
{
"text": "事件参考",
"link": "/vbman2/events"
},
{
"text": "设置配置",
"link": "/vbman2/settings"
},
{
"text": "高级功能",
"link": "/vbman2/advanced"
},
{
"text": "进程管理",
"link": "/vbman2/process"
}
]
}
],
"/biz/cs-auther/": [
{
"text": "网络验证框架",
"items": [
{
"text": "介绍",
"link": "/biz/cs-auther/index"
},
{
"text": "快速开始",
"link": "/biz/cs-auther/quickstart"
},
{
"text": "系统架构",
"link": "/biz/cs-auther/architecture"
},
{
"text": "通信协议",
"link": "/biz/cs-auther/protocol"
},
{
"text": "客户端模块",
"link": "/biz/cs-auther/client"
},
{
"text": "服务端模块",
"link": "/biz/cs-auther/server"
},
{
"text": "共享模块",
"link": "/biz/cs-auther/shared"
},
{
"text": "文件传输",
"link": "/biz/cs-auther/filetransfer"
},
{
"text": "日志系统",
"link": "/biz/cs-auther/logging"
}
]
}
]
},
"footer": {
"message": "VB6及其LOGO版权为微软公司所有",
"copyright": "VBMAN 版权所有 © 2019-2026 邓伟"
},
"docFooter": {
"prev": "上一页",
"next": "下一页"
},
"lastUpdated": {
"text": "最后更新",
"formatOptions": {
"dateStyle": "short",
"timeStyle": "short",
"timeZone": "Asia/Shanghai"
}
}
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "demo/api-examples.md",
"filePath": "demo/api-examples.md",
"lastUpdated": 1746428702000
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.