跳到主要内容

远程函数

远程函数

远程函数是带类型的服务器入口——应用向服务器请求实时查询或变更无法表达之物的方式。它们以 src/functions/+<lower_snake_case>.ts 编写;文件名就是规范的远程函数 ID,并成为生成的 client.invoke 属性。不存在注册模块。

定义

import { defineQueryHandler } from '@norbital-ai/bolt/authoring';
import { Effect, Schema } from 'effect';

export default defineQueryHandler({
  description: 'Counts the visits recorded against one site.',
  schema: Schema.Struct({ site_id: Schema.String }),
  handler: ({ site_id }, api) =>
    Effect.gen(function* () {
      return yield* api.db.query.site_visits.count({
        where: { site_id: { eq: site_id } }
      });
    })
});

把这份查询保存为 src/functions/+visit_count.ts ,然后从应用通过生成的客户端边界调用它:

import { client } from '$bolt/client';

const count = client.invoke.visit_count({ site_id: selectedSite });

查询与命令

  • defineQueryHandler ——响应式的只读服务器计算
  • defineCommandHandler ——可能变更数据的命令式工作

变更副作用优先使用集合钩子,定时或事件驱动的后台工作优先使用自动化。远程函数用于带类型化请求/响应约定的服务器计算。