sz-log

一个精简的日志记录 SDK，对 TS 友好。

安装

yarn add sz-log

npm install sz-log --save

起步

1. 在入口文件中初始化 SDK

例：React 应用中

index.tsx

import React from 'react';
import App from './App';
import logs from 'sz-log';

logs.init();

ReactDOM.render(
 <React.StrictMode>
  <App />
  <Toaster />
 </React.StrictMode>,
 document.getElementById('root'),
);

例：在 Vue 项目中

main.ts

import { createApp } from 'vue'
import App from './App.vue'
import logs from 'sz-log';

logs.init();

createApp(App).mount('#app')

2. 使用

例：在 React 项目中

import React, { useEffect } from 'react';
import logs from 'sz-log';

function App() {
 React.useEffect(() => {
   fetch('http://www.example.com').catch((e) => {
     logs.error(e.message);
   });
 }, []);

 return <div></div>;
}
export default App;

例：在 Vue 项目中

<script setup>
  import HelloWorld from './components/HelloWorld.vue'
  import logs from 'sz-log';
  fetch('https://www.example.com').catch((e) => logs.error(e.message));
</script>

<template>
  <img alt="Vue logo" src="./assets/logo.png" />
  <HelloWorld msg="Hello Vue 3 + Vite" />
</template>

API Reference

logs.init(opts: Options) => void

interface Options {
  enableConsole?: boolean;
  prefix?: string;
}

| Param | Type | Description | | ----- | ------- | ----------- | | opts | Options | 初始化参数 |

logs.record(type, msg) => void

| Param | Type | Description | | ----- | --------------------------- | ----------- | | type | 'error' | 'warn' | 'info' | 日志类型 | | msg | string | 日志信息 |

logs.error(msg) => void

| Param | Type | Description | | ----- | -------- | ----------- | | msg | string | 日志信息 |

logs.warn(msg) => void

| Param | Type | Description | | ----- | -------- | ----------- | | msg | string | 日志信息 |

logs.info(msg) => void

| Param | Type | Description | | ----- | -------- | ----------- | | msg | string | 日志信息 |