@builder.io/console-feed

中文文档
3.0.0-1发布于 2020/03/30MITTypeScriptCommonJS近 30 天下载 2350

从当前页面显示控制台日志、 iframe 或通过服务器传输的反射组件

中文使用文档
文档目录16 节
  1. 谁用它
  2. 特征
  3. 安装
  4. 基本用途
  5. 主张 <Console /> 组件
  6. logs: Log[]
  7. filter?: Methods[]
  8. variant?: 'light' | 'dark'
  9. style?: Styles
  10. searchKeywords?: string
  11. logFilter?: Function
  12. 日志方法
  13. Log 对象
  14. 序列化
  15. 禁用序列化
  16. 发展中国家

控制台饲料

npm version CircleCI npm downloads Demo

从当前页面显示控制台日志、 iframe 或通过服务器传输的回放组件 .

Demo

谁用它

特征

  • 控制台格式化 - 说吧 样式并给出日志颜色链接
  • DOM 节点 - 方便检查和扩展 HTML 元素,并加亮语法
  • console.table - 用表格格式查看日志
  • 其他控制台方法数字 :
    • console.time - 以毫秒计算完成事件所需的时间
    • console.assert - 声明是真实的
    • console.count - 数一下发生多少事
  • JSON 内置序列化 - 对象、函数和 DOM 元素可编码或解码为 JSON

安装

yarn add console-feed
# or
npm install console-feed

基本用途

代码框

import React from 'react'
import { Hook, Console, Decode } from 'console-feed'

class App extends React.Component {
  state = {
    logs: []
  }

  componentDidMount() {
    Hook(window.console, log => {
      this.setState(({ logs }) => ({ logs: [...logs, Decode(log)] }))
    })

    console.log(`Hello world!`)
  }

  render() {
    return (
      <div style={{ backgroundColor: '#242424' }}>
        <Console logs={this.state.logs} variant="dark" />
      </div>
    )
  }
}

主张 <Console /> 组件

logs: Log[]

由日志对象组成的数组 。 需求

filter?: Methods[]

过滤日志, 只显示某些方法的信息 .

variant?: 'light' | 'dark'

设置组件的字体颜色。 默认 - light

style?: Styles

定义组件上的自定义样式 - 参见 Styles.d.ts

searchKeywords?: string

过滤日志的字符串值

logFilter?: Function

如果您想要使用自定义日志过滤功能, 您可以提供自己的执行

日志方法

每个日志都有指定的方法. 该方法用于确定信件的样式和用于 filter 道具 (英语).

type Methods =
  | 'log'
  | 'warn'
  | 'error'
  | 'info'
  | 'debug'
  | 'command'
  | 'result'

Log 对象

日志对象包括以下内容:

type Logs = Log[]

interface Log {
  // The log method
  method: Methods
  // The arguments passed to console API
  data: any[]
}

序列化

默认使用时 Hook() API,日志被序列化,以便安全工作 JSON.stringify。为了将日志恢复到兼容格式 <Console /> 组件,您需要调用 Decode() 方法.

禁用序列化

如果 Hook 函数和 <Console /> 组件的源代码相同,可以禁用序列化来增加性能.

Hook(
  window.console,
  log => {
    this.setState(({ logs }) => ({ logs: [...logs, log] }))
  },
  false
)

发展中国家

运行 console-feed 本地, 只需运行 :

yarn
yarn start
yarn test:watch

头去 http://localhost:3000 在浏览器中,你会看到演示页出现。 在你做出修改后,你需要重新装入,但笑话测试会自动重启.

版本与发布记录

@builder.io/console-feed 共发布 1 个版本,首次发布于 2020/03/30;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.0-1latest2020/03/306 年前

关于 @builder.io/console-feed 的常见问题

@builder.io/console-feed 是什么?

从当前页面显示控制台日志、 iframe 或通过服务器传输的反射组件

如何安装 @builder.io/console-feed?

在项目目录运行 npm install @builder.io/console-feed,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^15.x || ^16.x)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@builder.io/console-feed 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@builder.io/console-feed 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@builder.io/console-feed 可以商用吗?

@builder.io/console-feed 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@builder.io/console-feed 的下载量有多少?

根据 npm 官方下载统计,@builder.io/console-feed 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,350 次,日均约 78 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@builder.io/console-feed 还在维护吗?

最新版本 3.0.0-1 发布于 2020/03/30(6 年前);至今共发布 1 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/03/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。