lite-ts-api
TypeScript icon, indicating that this package has built-in type declarations

11.22.4 • Public • Published

Version

代码

ApiHandler - api处理器

const fileFactory: FileFactoryBase;
const cfg: ApiHandlerConfig;
const handler = new ApiHandler(fileFactory, cfg, package.json);

// 认证加解密
const res = handler.authCrypto;

// 跟踪
const res = handler.tracer;

// 处理api
const res = await handler.handle<T>(req);
// res is RpcResponse<T>

IApi - api接口

const api: IApi;

const res = api.call();

IApiPort - api端

const port: IApiPort;

// 监听
await port.listen();

ApiSession - api会话

const session: ApiSession;

// 是否可选
const res = session.isSessionOptional;

// 会话数据
const res = await session.sessionData;
const data: Promise<ApiSessionData>;
session.sessionData = data;

export class XxApi extends ApiSession {
    // 会话可选
    @ClassTransformerValidateNested(ApiSessionData)
    @IsObject()
    @IsOptional()
    public sessionData: ApiSessionData;

    public async call() {
        // coding...
    }
}
  • ApiUserSession<T extends IUserService>
export class XxApi extends ApiUserSession<IUserSession> {
    public async call() {
        const userService = this.userService;
        // coding
    }
}

RpcSession - 会话数据

  • ApiSessionData - 会话数据(包含验证规则)
const data: ApiSessionData;

// 区服编号
const res = data.areaNo;

// 会话id
const res = data.id;

// 项目编号
const res = data.projectNo;

Readme

Keywords

Package Sidebar

Install

npm i lite-ts-api

Weekly Downloads

7

Version

11.22.4

License

GPL-3.0

Unpacked Size

92 kB

Total Files

39

Last publish

Collaborators

  • ahl5esoft