@ conduit-client/ 绑定- utils

用于在不同环境中连贯地建立管道约束的功能和类型.

概览

这个软件包为错误处理,命令类型定义,以及LWC和强制约束执行中使用的常见模式提供了核心功能. 它充当了在康杜特生态系统中建立坚固数据绑定的基础层.

关键特性

• 处理错误: 综合出错发现和处理设施
• 命令类型: 不同命令结果模式的类型定义
• 记录公用事业: 标准化错误记录和转换

API 参考

处理公用事业出错

isInternalError(error: unknown): boolean

确定错误是否为内部系统错误.

isUserVisibleError(error: unknown): boolean

检查是否向终端用户显示出错 .

getErrorResponse(error: unknown)

将出错转换为标准响应格式.

logError(error: unknown, logger?: Logger)

记录错误,并有适当的上下文和格式.

命令类型

ResultCommand<R>

命令返回一个直接结果.

SubscribableResultCommand<R>

命令返回可分解的结果以进行被动更新 .

MaybeSubscribableResultCommand<R>

命令可以返回直接或可分解的结果.

ResultOrSubscribableResult<R>

用于结果灵活性的联盟类型.

用法实例

处理错误

import { isInternalError, isUserVisibleError, logError } from '@conduit-client/bindings-utils/v1';

try {
  // Your code here
} catch (error) {
  if (isInternalError(error)) {
    // Handle internal error
    logError(error);
  } else if (isUserVisibleError(error)) {
    // Show error to user
    showUserNotification(error);
  }
}

命令类型使用

import type { ResultCommand, SubscribableResultCommand } from '@conduit-client/bindings-utils/v1';

// Direct result command
const fetchData: ResultCommand<UserData> = {
  execute: () => Promise.resolve(userData),
};

// Subscribable command for reactive data
const subscribeToData: SubscribableResultCommand<UserData> = {
  execute: () => ({
    subscribe: (callback) => {
      // Subscribe logic
      return unsubscribe;
    },
  }),
};

依赖关系

• @conduit-client/utils: 核心公用事业职能
• @conduit-client/command-base: 基地命令接口