npm 包 @mrgalaxy/shorturl 使用教程

介绍

在前端开发中，经常会涉及到 URL 的处理和转换的操作。npm 库提供了很多工具包，其中 @mrgalaxy/shorturl 是一个轻量级的 URL 短链接生成器。该库的使用可以简化前端 URL 管理和处理的代码，同时提高工作效率。

安装

该库可以直接通过 npm 安装：

npm install @mrgalaxy/shorturl

基本使用

使用该库生成短链接非常简单，只需要引入该库，然后传入要生成短链接的 URL 即可。以下是一个基本的示例代码：

import shorturl from '@mrgalaxy/shorturl';

const longUrl = 'https://www.example.com/article/123';
const shortUrl = shorturl(longUrl);
console.log(shortUrl);  // https://s.gly.com/xYb4c

配置项

该库支持一些基本配置来满足不同的使用需求。以下是可用配置项：

• domain: 自定义短链接域名，默认是 s.gly.com。

使用配置项的示例如下：

import shorturl from '@mrgalaxy/shorturl';

const longUrl = 'https://www.example.com/article/123';
const options = { domain: 'https://custom.com' };
const shortUrl = shorturl(longUrl, options);
console.log(shortUrl);  // https://custom.com/xYb4c

注意事项

• 只能处理 HTTP 和 HTTPS 协议的 URL。
• 由于短链接是通过数据库存储，所以请确保数据库的安全性。
• 短链接的有效期为 7 天，超过有效期的链接将失效。

结论

@mrgalaxy/shorturl 是一个轻量级的 URL 短链接生成器，使用简单，提高了前端 URL 管理和处理的效率。同时，该库支持自定义配置，满足不同的使用需求。在实际的前端开发工作中，可考虑使用该库来简化 URL 处理和管理的代码。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcc967216659e244821