kbor-logger v1.0.9

klogger

klogger 是一个用于在浏览器控制台中输出美观日志的工具，支持不同类型的日志输出（info、error、warning、success），并且支持输出对象和数组，提升调试体验。

安装

使用 npm 安装

npm install kbor-logger

使用 yarn 安装

yarn add kbor-logger

使用方法

导入方式

在你的项目中导入 klogger：

// 在模块中导入
import { klogger } from 'kbor-logger';

// 或者通过 require 导入
const { klogger } = require('kbor-logger');

基本使用

klogger 提供了以下几种日志类型：info、error、warning 和 success。你可以使用这些方法来打印不同类型的日志信息。

输出信息

klogger().info("This is an info message!");

输出对象或数组

支持打印对象或数组，并且在控制台中以可展开的格式显示：

klogger().info({ key: 'value' });
klogger().info([{ key: 'value' }, { key: 'value' }]);

带标题的日志

你可以为日志添加标题，格式如下：

klogger().info("Title", "This is the content of the info log.");
klogger().error("Error Title", "An error occurred!");
klogger().warning("Warning Title", "This is a warning message.");
klogger().success("Success Title", "Operation was successful.");

图片日志

klogger 还支持将图片显示为背景图，在控制台输出类似图片的效果：

klogger().picture("https://example.com/image.png", 0.5);

日志输出格式

​ • info：以灰色背景输出

​ • error：以红色背景输出

​ • warning：以橙色背景输出

​ • success：以绿色背景输出

这些日志将以控制台中的彩色方式显示，帮助区分不同类型的日志。

通过库 导入

klogger 默认是自适应的，会根据输入的内容判断如何输出。如果输入的是对象或数组，它会折叠输出，点击展开。如果是字符串，则以标准的彩色日志输出。

klogger().info("My Info", "This is an info message.");
klogger().error("My Error", { message: "Something went wrong!" });
klogger().warning("My Warning", [{ item: 1 }, { item: 2 }]);
klogger().success("My Success", "The task was completed successfully.");

浏览器环境

<script src="path/to/kbor-logger.js"></script>
<script>
    klogger.info("Object Data", { key: 'value', nested: { key2: 'value2' } });
</script>

常见问题

为什么有时候图片不会显示？

klogger().picture 使用 canvas 来绘制图片，并将其作为背景显示。如果图片跨域或有其他限制，可能会导致无法显示。确保图片没有跨域问题，或使用 crossOrigin 设置为 'anonymous'。