Skip to content
English

HandlerOptions ​

KIT · interface · 类型合同

Options shared by the standalone server and the bare request handler.

导入 ​

ts
import type { HandlerOptions } from '@jangts/agent-core/mock/node';
js
/** @typedef {import('@jangts/agent-core/mock/node').HandlerOptions} HandlerOptions */

其他公开入口:@jangts/agent-core/mock/node。

定义 ​

ts
interface HandlerOptions

字段结构 ​

字段类型必需说明
mockMockGPT必需Instance whose fetch answers every accepted request.
maxBodyBytesnumber | undefined可省略Maximum request body in bytes; default 1 MiB.
requestTimeoutMsnumber | undefined可省略Deadline for one request including streaming, in milliseconds; default 30 000.
allowedOriginsreadonly string[] | undefined可省略Exact origins allowed to call cross-origin; same-origin requests always pass.
allowedHostsreadonly string[] | undefined可省略Extra hostnames accepted in Host; localhost, 127.0.0.1 and ::1 are always accepted.

使用示例 ​

启动最小模型 API,用完关闭 ​

入门 · Node.js

ts
import { MockGPT } from '@jangts/agent-core/mock';
import { createMockServer } from '@jangts/agent-core/mock/node';
const mock = new MockGPT({ rules: [{ prompt: '你好', generator: '你好。' }] });
const server = createMockServer({ mock });
try {
  const address = await server.listen({ host: '127.0.0.1', port: 0 });
  console.log(address);
  // 将输出地址的 /v1 作为模型客户端 base URL。
} finally { await server.close(); }
js
import { MockGPT } from '@jangts/agent-core/mock';
import { createMockServer } from '@jangts/agent-core/mock/node';
const mock = new MockGPT({ rules: [{ prompt: '你好', generator: '你好。' }] });
const server = createMockServer({ mock });
try {
    const address = await server.listen({ host: '127.0.0.1', port: 0 });
    console.log(address);
    // 将输出地址的 /v1 作为模型客户端 base URL。
}
finally {
    await server.close();
}

挂入已有 Node HTTP 生命周期 ​

配置 · Node.js

ts
import { createServer } from 'node:http';
import { MockGPT } from '@jangts/agent-core/mock';
import { createMockHandler } from '@jangts/agent-core/mock/node';
const mock = new MockGPT({ rules: [{ generator: '演示回复' }] });
const handler = createMockHandler({ mock, requestTimeoutMs: 5000 });
const server = createServer(handler);
server.listen(4317, '127.0.0.1');
// 宿主退出时关闭 server;需要自定义域名时显式配置 allowedHosts。
js
import { createServer } from 'node:http';
import { MockGPT } from '@jangts/agent-core/mock';
import { createMockHandler } from '@jangts/agent-core/mock/node';
const mock = new MockGPT({ rules: [{ generator: '演示回复' }] });
const handler = createMockHandler({ mock, requestTimeoutMs: 5000 });
const server = createServer(handler);
server.listen(4317, '127.0.0.1');
// 宿主退出时关闭 server;需要自定义域名时显式配置 allowedHosts。

相关定义 ​

接口参考、使用示例与开发指南。