T Comm

Appearance

引入 ​

ts
import {
  getCanvas,
  getChalk,
  getCheerio,
  getCosNodejsSdkV5,
  getCronParser,
  getDotenvExpand,
  getDotenv,
  getFormData,
  getFsExtra,
  getGlob,
  getImageSize,
  getJose,
  getLogSymbols,
  getMiniprogramCi,
  getQs,
  getTar,
  getVue,
  getXlsx
} from 't-comm';

// 不支持 tree-shaking 的项目
import {
  getCanvas,
  getChalk,
  getCheerio,
  getCosNodejsSdkV5,
  getCronParser,
  getDotenvExpand,
  getDotenv,
  getFormData,
  getFsExtra,
  getGlob,
  getImageSize,
  getJose,
  getLogSymbols,
  getMiniprogramCi,
  getQs,
  getTar,
  getVue,
  getXlsx
} from 't-comm/lib/third-party/index';

// 只支持 ESM 的项目
import {
  getCanvas,
  getChalk,
  getCheerio,
  getCosNodejsSdkV5,
  getCronParser,
  getDotenvExpand,
  getDotenv,
  getFormData,
  getFsExtra,
  getGlob,
  getImageSize,
  getJose,
  getLogSymbols,
  getMiniprogramCi,
  getQs,
  getTar,
  getVue,
  getXlsx
} from 't-comm/es/third-party/index';

getCanvas() ​

描述：获取 canvas 库 canvas 是一个用于在 Node.js 中使用 Canvas API 的第三方库

参数：

返回: canvas 库

示例

ts
const { createCanvas } = getCanvas();
const canvas = createCanvas(200, 100);

getChalk() ​

描述：获取 chalk 库 chalk 是一个用于在终端输出彩色文本的第三方库

参数：

返回: chalk 库

示例

ts
const chalk = getChalk();
console.log(chalk.red('error message'));

getCheerio() ​

描述：获取 cheerio 库 cheerio 是一个用于在服务端解析 HTML 的第三方库

参数：

返回: cheerio 库

示例

ts
const cheerio = getCheerio();
const $ = cheerio.load('<h1>hello</h1>');
$('h1').text(); // 'hello'

getCosNodejsSdkV5() ​

描述：获取 cos-nodejs-sdk-v5 库 cos-nodejs-sdk-v5 是腾讯云对象存储 COS 的 Node.js SDK

参数：

返回: cos-nodejs-sdk-v5 库

示例

ts
const COS = getCosNodejsSdkV5();
const cos = new COS({ SecretId: '...', SecretKey: '...' });

getCronParser() ​

描述：获取 cron-parser 库 cron-parser 是一个用于解析 cron 表达式的第三方库

参数：

返回: cron-parser 库

示例

ts
const cronParser = getCronParser();
const interval = cronParser.parseExpression('0 0 * * *');
interval.next().toString();

getDotenvExpand() ​

描述：获取 dotenv-expand 库 dotenv-expand 是一个用于扩展 dotenv 环境变量的第三方库

参数：

返回: dotenv-expand 库

示例

ts
const dotenvExpand = getDotenvExpand();
dotenvExpand.expand({ parsed: { FOO: 'bar', BAZ: '$FOO' } });

getDotenv() ​

描述：获取 dotenv 库 dotenv 是一个用于加载环境变量的第三方库

参数：

返回: dotenv 库

示例

ts
const dotenv = getDotenv();
dotenv.config({ path: '.env.local' });

getFormData() ​

描述：获取 form-data 库 form-data 是一个用于创建表单数据的第三方库

参数：

返回: form-data 库

示例

ts
const FormData = getFormData();
const form = new FormData();
form.append('field', 'value');

getFsExtra() ​

描述：获取 fs-extra 库 fs-extra 是一个扩展了 Node.js fs 模块的第三方库

参数：

返回: fs-extra 库

示例

ts
const fse = getFsExtra();
await fse.copy('src', 'dist');

getGlob() ​

描述：获取 glob 库 glob 是一个用于文件匹配的第三方库

参数：

返回: glob 库

示例

ts
const { glob } = getGlob();
const files = await glob('src/** /*.ts');

getImageSize() ​

描述：获取 image-size 库 image-size 是一个用于获取图片尺寸的第三方库

参数：

返回: image-size 库

示例

ts
const sizeOf = getImageSize();
const dimensions = sizeOf('test.png'); // { width, height, type }

getJose() ​

描述：获取 jose 库 jose 是一个用于 JSON Web Encryption (JWE) 和 JSON Web Signature (JWS) 的第三方库

参数：

返回: jose 库

示例

ts
const jose = getJose();
const { payload } = await jose.jwtVerify(token, secret);

getLogSymbols() ​

描述：获取 log-symbols 库 log-symbols 是一个用于在终端显示彩色符号的第三方库

参数：

返回: log-symbols 库

示例

ts
const logSymbols = getLogSymbols();
console.log(logSymbols.success, 'done');

getMiniprogramCi() ​

描述：获取 miniprogram-ci 库 miniprogram-ci 是微信小程序的命令行工具

参数：

返回: miniprogram-ci 库

示例

ts
const ci = getMiniprogramCi();
const project = new ci.Project({ appid: '...', type: 'miniProgram' });

getQs() ​

描述：获取 qs 库 qs 是一个用于解析和序列化查询字符串的第三方库

参数：

返回: qs 库

示例

ts
const qs = getQs();
qs.parse('a=1&b=2'); // { a: '1', b: '2' }
qs.stringify({ a: 1 }); // 'a=1'

getTar() ​

描述：获取 tar 库 tar 是一个用于处理 tar 压缩包的第三方库

参数：

返回: tar 库

示例

ts
const tar = getTar();
await tar.create({ file: 'out.tgz' }, ['src']);

getVue() ​

描述：获取 vue 库 vue 是一个用于构建用户界面的渐进式框架

参数：

返回: vue 库

示例

ts
const Vue = getVue();
const app = Vue.createApp({});

getXlsx() ​

描述：获取 xlsx 库 xlsx 是一个用于处理 Excel 文件的第三方库

参数：

返回: xlsx 库

示例

ts
const XLSX = getXlsx();
const workbook = XLSX.readFile('data.xlsx');