@jayfong/x-server 1.26.5 → 1.26.6

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.26.6](https://github.com/jfWorks/x-server/compare/v1.26.5...v1.26.6) (2022-05-07)
+
+
+### Bug Fixes
+
+* ServiceOptions ([bd86e66](https://github.com/jfWorks/x-server/commit/bd86e6618a5e115cbba26b56dfbeba2a427bfda7))
+
 ### [1.26.5](https://github.com/jfWorks/x-server/compare/v1.26.4...v1.26.5) (2022-05-06)
 
 

package/lib/_cjs/services/sensitive_words.js

@@ -7,14 +7,21 @@ exports.SensitiveWordsService = void 0;
 
 var _mintFilter = _interopRequireDefault(require("mint-filter"));
 
+/**
+ * 敏感词服务。
+ */
 class SensitiveWordsService {
   constructor(options) {
     this.options = options;
     this.serviceName = 'sensitiveWords';
     this.mint = void 0;
   }
+  /**
+   * 处理文本，敏感词将被替换为 * 号。
+   */
 
-  async filter(text) {
+
+  async process(text) {
     if (!this.mint) {
       this.mint = new _mintFilter.default(this.options.words);
     }

package/lib/services/cache.d.ts

@@ -1,10 +1,9 @@
 import { AsyncOrSync, IsEmptyArray, NonEmptyArray } from 'vtils/types';
 import { BaseService } from './base';
 import { MsValue } from 'vtils/date';
-export declare type CacheTTL = MsValue;
-export interface CacheOptions {
+export interface CacheServiceOptions {
     /** 默认过期时间 */
-    ttl: CacheTTL;
+    ttl: MsValue;
 }
 declare type Data = {
     [K in string]: (...args: any[]) => any;
@@ -18,10 +17,10 @@ declare type KeyPathForNumberValue<T extends Data> = {
 }[keyof T];
 declare type Value<T extends Data, P extends KeyPath<T>> = ReturnType<T[P extends any[] ? P[0] : P]>;
 export declare class CacheService<TData extends Data = Data, TKey extends Key<TData> = any, TKeyPath extends KeyPath<TData> = any, TKeyPathForNumberValue extends KeyPathForNumberValue<TData> = any> implements BaseService {
-    options: CacheOptions;
+    options: CacheServiceOptions;
     serviceName: string;
     private prefix;
-    constructor(options: CacheOptions);
+    constructor(options: CacheServiceOptions);
     private toRedisKey;
     /**
      * 设置缓存内容。对象类内容尽量避免使用，以免造成问题。
@@ -31,14 +30,14 @@ export declare class CacheService<TData extends Data = Data, TKey extends Key<TD
      * @param ttl 缓存时间（单位：时）
      * @returns 返回设置的缓存内容
      */
-    set<K extends TKeyPath, V extends Value<TData, K>>(key: K, value: V, ttl?: CacheTTL | ((data: V, defaultTTL: CacheTTL) => CacheTTL)): Promise<V>;
+    set<K extends TKeyPath, V extends Value<TData, K>>(key: K, value: V, ttl?: MsValue | ((data: V, defaultTTL: MsValue) => MsValue)): Promise<V>;
     /**
      * 存储值然后返回其对应的键，该键 URL 友好。
      *
      * @param value 值
      * @param ttl 存活时间
      */
-    save<T>(value: T | ((key: string) => AsyncOrSync<T>), ttl?: CacheTTL): Promise<string>;
+    save<T>(value: T | ((key: string) => AsyncOrSync<T>), ttl?: MsValue): Promise<string>;
     /**
      * 获取缓存内容。
      *
@@ -61,7 +60,7 @@ export declare class CacheService<TData extends Data = Data, TKey extends Key<TD
      * @param ttl 缓存时间（单位：时）
      * @returns 返回获取到的内容
      */
-    remember<K extends TKeyPath, V extends Value<TData, K>>(key: K, action: () => V | Promise<V>, ttl?: CacheTTL | ((data: V, defaultTTL: CacheTTL) => CacheTTL)): Promise<V>;
+    remember<K extends TKeyPath, V extends Value<TData, K>>(key: K, action: () => V | Promise<V>, ttl?: MsValue | ((data: V, defaultTTL: MsValue) => MsValue)): Promise<V>;
     /**
      * 自增。
      *
@@ -107,7 +106,7 @@ export declare class CacheService<TData extends Data = Data, TKey extends Key<TD
     /**
      * 派生出一个指定类型的缓存服务。
      */
-    fork<TNextData extends Data>(options?: Partial<CacheOptions>): CacheService<TNextData, Key<TNextData>, KeyPath<TNextData>, KeyPathForNumberValue<TNextData>>;
+    fork<TNextData extends Data>(options?: Partial<CacheServiceOptions>): CacheService<TNextData, Key<TNextData>, KeyPath<TNextData>, KeyPathForNumberValue<TNextData>>;
 }
 declare module '../x' {
     interface X {

package/lib/services/captcha.d.ts

@@ -1,6 +1,6 @@
 import { BaseService } from './base';
 import type { MsValue } from 'vtils/date';
-export interface CaptchaOptions {
+export interface CaptchaServiceOptions {
     /**
      * 验证码长度
      */
@@ -10,32 +10,32 @@ export interface CaptchaOptions {
      */
     ttl: MsValue;
 }
-export interface CaptchaGenerateResult {
+export interface CaptchaServiceGenerateResult {
     token: string;
     code: string;
 }
-export interface CaptchaGenerateImageResult {
+export interface CaptchaServiceGenerateImageResult {
     token: string;
     code: string;
     svg: string;
 }
-export interface CaptchaGenerateDataUrlResult {
+export interface CaptchaServiceGenerateDataUrlResult {
     token: string;
     code: string;
     dataUrl: string;
 }
-export interface CaptchaVerifyOptions {
+export interface CaptchaServiceVerifyOptions {
     token: string;
     code: string;
 }
 export declare class CaptchaService implements BaseService {
     private options;
     serviceName: string;
-    constructor(options: CaptchaOptions);
-    generate(): Promise<CaptchaGenerateResult>;
-    generateImage(): Promise<CaptchaGenerateImageResult>;
-    generateDataUrl(): Promise<CaptchaGenerateDataUrlResult>;
-    verify(options: CaptchaVerifyOptions): Promise<boolean>;
+    constructor(options: CaptchaServiceOptions);
+    generate(): Promise<CaptchaServiceGenerateResult>;
+    generateImage(): Promise<CaptchaServiceGenerateImageResult>;
+    generateDataUrl(): Promise<CaptchaServiceGenerateDataUrlResult>;
+    verify(options: CaptchaServiceVerifyOptions): Promise<boolean>;
 }
 declare module '../x' {
     interface X {

package/lib/services/dispose.d.ts

@@ -1,11 +1,11 @@
 import { BaseService } from './base';
-export interface DisposeOptions {
+export interface DisposeServiceOptions {
     disposeOnExit?: boolean;
 }
 export declare class DisposeService implements BaseService {
     private options?;
     serviceName: string;
-    constructor(options?: DisposeOptions);
+    constructor(options?: DisposeServiceOptions);
     private disposes;
     add(fn: () => any): void;
     dispose(): Promise<any[]>;

package/lib/services/pay.d.ts

@@ -1,5 +1,5 @@
 import { BaseService } from './base';
-export interface PayOptions {
+export interface PayServiceOptions {
     /** 支付宝 */
     alipay?: {
         /** 应用 ID */
@@ -23,7 +23,7 @@ export interface PayOptions {
         secretKey: string;
     };
 }
-export interface PayPrepareAlipayOptions {
+export interface PayServicePrepareAlipayOptions {
     /** 商品名称 */
     goodsName: string;
     /** 交易单号 */
@@ -35,11 +35,11 @@ export interface PayPrepareAlipayOptions {
     /** 返回地址 */
     returnUrl?: string;
 }
-export interface PayPrepareAlipayResult {
+export interface PayServicePrepareAlipayResult {
     /** 支付地址，需跳转过去 */
     payUrl: string;
 }
-export interface PayPrepareWepayOptions {
+export interface PayServicePrepareWepayOptions {
     /** 商品名称 */
     goodsName: string;
     /** 交易单号 */
@@ -51,7 +51,7 @@ export interface PayPrepareWepayOptions {
     /** 对应公众号用户的 openid */
     openid: string;
 }
-export interface PayPrepareWepayResult {
+export interface PayServicePrepareWepayResult {
     /** 支付参数，可直接传给 JSSDK 调用 */
     payParams: {
         appId: string;
@@ -66,9 +66,9 @@ export declare class PayService implements BaseService {
     private options;
     serviceName: string;
     private alipaySdk;
-    constructor(options: PayOptions);
-    prepareAlipay(options: PayPrepareAlipayOptions): Promise<PayPrepareAlipayResult>;
-    prepareWepay(options: PayPrepareWepayOptions): Promise<PayPrepareWepayResult>;
+    constructor(options: PayServiceOptions);
+    prepareAlipay(options: PayServicePrepareAlipayOptions): Promise<PayServicePrepareAlipayResult>;
+    prepareWepay(options: PayServicePrepareWepayOptions): Promise<PayServicePrepareWepayResult>;
     verifyNotifyData(data: any): boolean;
     verifyNotifyDataOrFail(data: any, message?: string): void;
     private wepaySign;

package/lib/services/rate_limit.d.ts

@@ -1,13 +1,13 @@
 import { BaseService } from './base';
 import { MsValue } from 'vtils/date';
-export interface RateLimitLimitByCountOptions {
+export interface RateLimitServiceLimitByCountOptions {
     key: string;
     count: number;
     ttl: MsValue;
 }
 export declare class RateLimitService implements BaseService {
     serviceName: string;
-    limitByCount(options: RateLimitLimitByCountOptions): Promise<number>;
+    limitByCount(options: RateLimitServiceLimitByCountOptions): Promise<number>;
 }
 declare module '../x' {
     interface X {

package/lib/services/redis.d.ts

@@ -1,5 +1,7 @@
 import Redis from 'ioredis';
 import { BaseService } from './base';
+export interface RedisServiceOptions extends Redis.RedisOptions {
+}
 export declare class RedisService extends Redis implements BaseService {
     serviceName: string;
 }

package/lib/services/sensitive_words.d.ts

@@ -1,13 +1,20 @@
 import { BaseService } from './base';
-export interface SensitiveWordsOptions {
+export interface SensitiveWordsServiceOptions {
+    /** 敏感词列表 */
     words: string[];
 }
+/**
+ * 敏感词服务。
+ */
 export declare class SensitiveWordsService implements BaseService {
     private options;
     serviceName: string;
     private mint;
-    constructor(options: SensitiveWordsOptions);
-    filter(text: string): Promise<string>;
+    constructor(options: SensitiveWordsServiceOptions);
+    /**
+     * 处理文本，敏感词将被替换为 * 号。
+     */
+    process(text: string): Promise<string>;
 }
 declare module '../x' {
     interface X {

package/lib/services/sensitive_words.js

@@ -1,12 +1,20 @@
 import Mint from 'mint-filter';
+
+/**
+ * 敏感词服务。
+ */
 export class SensitiveWordsService {
   constructor(options) {
     this.options = options;
     this.serviceName = 'sensitiveWords';
     this.mint = void 0;
   }
+  /**
+   * 处理文本，敏感词将被替换为 * 号。
+   */
+
 
-  async filter(text) {
+  async process(text) {
     if (!this.mint) {
       this.mint = new Mint(this.options.words);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "1.26.5",
+  "version": "1.26.6",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",