52 lines
1.2 KiB
TypeScript
52 lines
1.2 KiB
TypeScript
|
/**
|
||
|
|
* @zh API 和消息定义助手
|
||
|
|
* @en API and message definition helpers
|
||
|
|
*/
|
||
|
|
|
||
|
|
import type { ApiDefinition, MsgDefinition } from '../types/index.js'
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @zh 定义 API 处理器
|
||
|
|
* @en Define API handler
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```typescript
|
||
|
|
* // src/api/join.ts
|
||
|
|
* import { defineApi } from '@esengine/server'
|
||
|
|
*
|
||
|
|
* export default defineApi<ReqJoin, ResJoin>({
|
||
|
|
* handler(req, ctx) {
|
||
|
|
* ctx.conn.data.playerId = generateId()
|
||
|
|
* return { playerId: ctx.conn.data.playerId }
|
||
|
|
* }
|
||
|
|
* })
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
export function defineApi<TReq, TRes, TData = Record<string, unknown>>(
|
||
|
|
definition: ApiDefinition<TReq, TRes, TData>
|
||
|
|
): ApiDefinition<TReq, TRes, TData> {
|
||
|
|
return definition
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @zh 定义消息处理器
|
||
|
|
* @en Define message handler
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```typescript
|
||
|
|
* // src/msg/input.ts
|
||
|
|
* import { defineMsg } from '@esengine/server'
|
||
|
|
*
|
||
|
|
* export default defineMsg<MsgInput>({
|
||
|
|
* handler(msg, ctx) {
|
||
|
|
* console.log('Input from', ctx.conn.id, msg)
|
||
|
|
* }
|
||
|
|
* })
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
export function defineMsg<TMsg, TData = Record<string, unknown>>(
|
||
|
|
definition: MsgDefinition<TMsg, TData>
|
||
|
|
): MsgDefinition<TMsg, TData> {
|
||
|
|
return definition
|
||
|
|
}
|