• 简体中文
  • Manifest API

    commflow@0.0.2 当前暴露的是 manifest API。manifest 用来描述计划中的通信能力边界,但它还不是 request、SSE、RPC 或 socket 的运行时 client。

    导入

    import {
      COMMFLOW_CHANNELS,
      createCommflowManifest
    } from 'commflow';
    
    const manifest = createCommflowManifest();

    导出项

    导出类型含义
    COMMFLOW_CHANNELSreadonly channel array四类计划中的通信方向:requestsserpcsocket
    createCommflowManifest()function返回一个新的 manifest 对象,用来描述当前包的方向。
    defaultfunctioncreateCommflowManifest() 是同一个函数。
    CommflowChannelTypeScript typeCOMMFLOW_CHANNELS 中 channel 名称的联合类型。
    CommflowChannelDescriptorTypeScript interface单个 channel descriptor 的字段结构。
    CommflowManifestTypeScript interface完整 manifest 对象的字段结构。

    Manifest 字段

    字段当前值含义
    namecommflow包身份。
    focusframework-agnosticcore 包方向:不把核心能力绑定到某个框架。
    primaryIntegrationvextjs第一个重点集成目标。
    plannedReplacementvext/app.fetch真实 request runtime 存在后计划替换的 VextJS request 路径。
    channels['request', 'sse', 'rpc', 'socket']manifest 暴露的稳定 channel 名称。
    descriptorschannel descriptor array每类计划通信能力的人读元数据。

    请把 manifest 当成描述性元数据。它适合用于文档、探针、demo 和早期集成规划。

    Channel descriptor 字段

    字段类型含义
    nameCommflowChannelchannel 名称。
    streamingboolean该通信方向是否预计涉及流式或长生命周期消息流。
    bidirectionalboolean该通信方向是否计划支持双向消息。
    primaryUsestring对计划用途的简短描述。

    当前 descriptor 值

    Channelstreamingbidirectional主要用途
    requestfalsefalse带 timeout、retry、tracing 和 proxy hooks 的 outbound HTTP request 编排。
    ssetruefalse服务端单向实时事件流,共享生命周期控制。
    rpctruetrue带 typed contracts 和 transport adapters 的过程式服务间通信。
    sockettruetrue用于事件驱动协作和会话感知消息的长连接双向通道。

    这个 API 不做什么

    commflow@0.0.2 还没有发布运行时 client。也就是说,当前还没有受支持的导入入口用于:

    • 发起 request
    • timeout 或 retry 策略
    • proxy 选择
    • 生命周期 hooks
    • SSE、RPC 或 socket adapters

    如果你需要计划中的 request runtime,请把 Request 预览 只当作设计方向阅读。除非 release notes 明确标记为已发布,否则不要把 preview 名称用于生产 import。