Halsp 文档

原生 NodeJS 服务 (@halsp/native)

安装 @halsp/native 以支持 NodeJS 原生运行环境

  • 让 Halsp 能够运行于 NodeJS 原生运行环境
  • 你可以随时将 Halsp 云函数简单改为 nginx 托管的 Halsp 原生服务
  • 也可以将 nginx 托管的 Halsp 原生服务简单改为 Halsp 云函数

安装

npm i @halsp/native

快速开始

以下示例开启一个服务，端口是 9504

import { NativeStartup } from "@halsp/native";

new NativeStartup()
  .use(async (ctx) => {
    ctx.ok("@halsp/native");
  })
  .listen(9504);

@halsp/native 也支持 https，上述示例中增加参数 https:true

new NativeStartup({
  https: true
})
  .use(async (ctx) => {
    ctx.ok("@halsp/native");
  })
  .listen(9504);

组合其他中间件

@halsp/router

import { NativeStartup } from "@halsp/native";
import "@halsp/router";

new NativeStartup()
  .useRouter()
  .listen(9504);

@halsp/static

import { NativeStartup } from "@halsp/native";
import "@halsp/static";

new NativeStartup()
  .useStatic()
  .listen(9504);

body 解析

基于 @halsp/body 支持四种 body 解析

import { NativeStartup } from "@halsp/native";
new NativeStartup()
  .useHttpJsonBody()
  .useHttpTextBody()
  .useHttpUrlencodedBody()
  .useHttpMultipartBody()
  .listen(9504);

json

接收参数参考 co-bodyopen in new window

startup.useHttpJsonBody()

或

startup.useHttpJsonBody({
  strict: true,
  limit: "1mb",
  encoding: "utf-8",
  returnRawBody: false,
  onError: (ctx, err) => {},
});

text

接收参数参考 co-bodyopen in new window

startup.useHttpTextBody()

或

startup.useHttpTextBody({
  limit: "1mb",
  encoding: "utf-8",
  returnRawBody: false,
  onError: (ctx, err) => {},
});

urlencoded

接收参数参考 co-bodyopen in new window

startup.useHttpUrlencodedBody()

或

startup.useHttpUrlencodedBody({
  queryString:'',
  limit: "1mb",
  encoding: "utf-8",
  returnRawBody: false,
  onError: (ctx, err) => {},
});

multipart

接收参数参考 formidableopen in new window

startup.useHttpMultipartBody()

或

startup.useHttpMultipartBody({
  opts: {
    multiples: true,
  },
  limit: "1mb",
  encoding: "utf-8",
  onFileBegin: async (ctx, formName, file) => {
    ctx.res.set("file-name", file.name ?? "");
  },
  onError: (ctx, err) => {},
});

httpRes & httpReq

为了更好的利用 halsp，正常情况使用 ctx.res 和 ctx.req 即可，并且可以更好的配合其他中间件。

为了应对特殊需求，@halsp/native 在 ctx 中也加入了 httpRes 和 httpReq，特殊情况下你也可以按原生方法操作 ctx.httpRes 和 ctx.httpReq，但不建议使用。

如果调用了 httpReq.end()，ctx.res 将不会被写入返回结果

入口

NativeStartup 作为 Halsp 运行于原生环境的入口

该类继承于 Startup 并实现 http 功能