@candriajs/git-neko-kit 1.1.0 → 1.1.1

package/dist/index.d.ts

@@ -25,9 +25,7 @@ declare enum ProxyProtocol {
     /** HTTPS */
     HTTPS = "https",
     /** SOCKS */
-    SOCKS = "socks",
-    /** SOCKS5 */
-    SOCKS5 = "socks5"
+    SOCKS = "socks"
 }
 /**
  * 基本代理配置
@@ -38,7 +36,7 @@ interface BaseProxyType<T extends ProxyType | ProxyProtocol> {
     address: ProxyUrlType;
 }
 /** 代理配置参数类型 */
-type ProxyParamsType = BaseProxyType<ProxyProtocol.HTTP> | BaseProxyType<ProxyProtocol.HTTPS> | BaseProxyType<ProxyProtocol.SOCKS> | BaseProxyType<ProxyProtocol.SOCKS5> | BaseProxyType<ProxyType.Common> | BaseProxyType<ProxyType.Reverse>;
+type ProxyParamsType = BaseProxyType<ProxyProtocol.HTTP> | BaseProxyType<ProxyProtocol.HTTPS> | BaseProxyType<ProxyProtocol.SOCKS> | BaseProxyType<ProxyType.Common> | BaseProxyType<ProxyType.Reverse>;
 
 /** 本地Git仓库信息 */
 interface GitRepoInfoType {
@@ -2080,19 +2078,18 @@ declare function get_remote_repo_default_branch(remote_url: string): Promise<str
  * 2. 有序列表项2
  * `);
  *
- * // 输出结果:
- * // <h1>标题</h1>
- * // <ul style="list-style: none;">
- * //   <li>无序列表项1</li>
- * //   <li>无序列表项2</li>
- * //   <ul style="list-style: none;">
- * //     <li>子列表项</li>
- * //   </ul>
- * // </ul>
- * // <ol style="list-style: none;">
- * //   <li>有序列表项1</li>
- * //   <li>有序列表项2</li>
- * // </ol>
+ * -> <h1>标题</h1>
+ *  <ul style="list-style: none;">
+ *    <li>无序列表项1</li>
+ *    <li>无序列表项2</li>
+ *    <ul style="list-style: none;">
+ *      <li>子列表项</li>
+ *    </ul>
+ *  </ul>
+ *  <ol style="list-style: none;">
+ *    <li>有序列表项1</li>
+ *    <li>有序列表项2</li>
+ * </ol>
  * ```
  */
 declare function render_markdown(md: string): Promise<string>;
@@ -2158,15 +2155,24 @@ declare function format_date(dateString: string, locale?: string, format?: strin
 /**
  * 获取相对时间
  * @param dateString - 日期字符串
- * @param locale - 语言环境，默认为 'zh-cn'
- * @returns 相对时间
+ * @param options - 可选参数对象
+ * @param options.locale - 语言环境，默认为 'zh-cn'
+ * @param options.useAbsoluteIfOver30Days - 是否在超过30天时返回绝对时间
+ * @returns 相对时间或绝对时间
  * @example
- * ```ta
+ * ```ts
  * console.log(await get_relative_time('2023-04-01 12:00:00'))
- * ->  1 小时前
+ * -> "1 小时前"
+ *
+ * // 如果当前时间距离该日期已超过30天，则返回绝对时间
+ * console.log(await get_relative_time('2023-01-01 12:00:00', { useAbsoluteIfOver30Days: true }))
+ * -> "2025-07-01 13:00:00"
  * ```
  */
-declare function get_relative_time(dateString: string, locale?: string): Promise<string>;
+declare function get_relative_time(dateString: string, options?: {
+    locale?: string;
+    useAbsoluteIfOver30Days?: boolean;
+}): Promise<string>;
 /**
  * 根据语言名称获取对应的颜色值
  * @param language - 语言名称