@lcap/nasl 3.9.0-beta.4 → 3.9.0-beta.41

package/sandbox-natural/stdlib/{nasl.util.ts → nasl.util.d.ts}

@@ -1,19 +1,27 @@
+/** 循环函数ForEach
+* 这是唯一一个可以在逻辑中使用的循环函数，用于遍历列表中的元素，禁止使用for、forEach等其他循环语句。
+*/
+declare function ForEach<T>(list: List<T>, start: Integer, end: Integer, fn: (item: T, index: Integer) => void): void;
+
+/* 基本运算函数，用于数学计算 */
+declare function plus(left: Decimal, right: Decimal): Decimal;
+declare function minus(left: Decimal, right: Decimal): Decimal;
+declare function multiply(left: Decimal, right: Decimal): Decimal;
+declare function divide(left: Decimal, right: Decimal): Decimal;
+declare function remainder(left: Decimal, right: Decimal): Decimal;
+
 declare namespace nasl.util {
-  // 类型转换与格式化函数
+  /* 类型转换与格式化函数 */
   export function Convert(value: null): <T extends never>() => T;
-  export function FormatNumber(doubleValue: Decimal | Integer, digits: Integer, showGroups: Boolean): String;
-  /**
-   * @example nasl.util.FormatDateTime(dataTime1, 'yyyy-MM-dd HH:mm:ss', 'global')
-  */
+  export function FormatNumber(doubleValue: Decimal | Long, digits: Long, showGroups: Boolean): String;
+  // @example nasl.util.FormatDateTime(dataTime1, 'yyyy-MM-dd HH:mm:ss', 'global')
   export function FormatDateTime(dateTime: DateTime, formatter: String, timeZone: string): String;
   export function FormatDate(date: Date, formatter: String): String;
-  /**
-   * @example nasl.util.FromString<Date>(variable1)
-   */
-  export function FromString<T extends Decimal | Date | Time | DateTime | Integer | Boolean>(value: String): T;
+  // @example nasl.util.FromString<Date>(variable1)
+  export function FromString<T extends Decimal | Date | Time | DateTime | Long | Boolean>(value: String): T;
   export function ToString(value: Any): String;
 
-  // 字符串函数
+  /* 字符串函数 */
   export function Length(str1: String): Decimal;
   export function Length<K, V>(str1: Map<K, V>): Decimal;
   export function Length<T>(str1: List<T>): Decimal;
@@ -22,24 +30,28 @@ declare namespace nasl.util {
   export function LastIndexOf(str: String, search: String, ignoreCase: Boolean): Decimal;
   export function Replace(str: String, search: String, replace: String): String;
   export function Split(str: String, seperator: String): List<String>;
-  export function SubString(str: String, start: Decimal, length: Integer): String;
+  export function SubString(str: String, start: Decimal, length: Long): String;
   export function ToLower(str1: String): String;
   export function ToUpper(str1: String): String;
   export function Trim(str1: String): String;
 
-  // 日期与时间函数
+  /* 日期与时间函数 */
   export function CurrDate(): Date;
   export function CurrDateTime(): DateTime;
   export function CurrTime(): Time;
-  export function DateDiff<T extends Date | Time | DateTime>(dateTime1: T, dateTime2: T, calcType: 'd' | 'h' | 'm' | 's', isAbs: Boolean): Decimal;
-  /* 为指定日期时间调整增加（减少）时间 */
+  // 计算两个日期时间之间的差值，calcType 支持年、季度、月、周、天、时分秒，默认为 'd'
+  export function DateDiff<T extends Date | Time | DateTime>(dateTime1: T, dateTime2: T, calcType: 'y' | 'q' | 'M' | 'w' | 'd' | 'h' | 'm' | 's', isAbs: Boolean): Decimal;
+  // 为指定日期时间调整增加（减少）时间
   export function AlterDateTime<T extends Date | DateTime>(dateTime: T, option: 'Increase' | 'Decrease', amount: Long, unit: 'day' | 'week' | 'month' | 'quarter' | 'year'): T;
-  /* 按指定维度计算日期，如“所在年-第几周”。当输入为 DateTime 类型时，会把数据转到提供的时区的当地时间进行计算。*/
-  export function GetDateCount<T extends Date | DateTime>(dateTime: T, metric: 'week-year', timeZone: string): Time;
-  /* 按“星期几”获取指定日期范围内的日子。当输入为 DateTime 类型时，会把数据转到提供的时区的当地时间进行计算。target 取值范围 [1,2,3,4,5,6,7] */
-  export function GetSpecificDaysOfWeek<T extends Date | DateTime>(startDate: T, endDate: T, target: List<Long>, timeZone?: String): List<T>;
+  /** 按指定维度计算日期的序号。当输入为 DateTime 类型时，会把数据转到提供的时区的当地时间进行计算
+  * @param dateTime: 日期或日期时间
+  * @param metric: 计算维度，格式为'小日期单位-大日期单位'。日期单位包括：'year'、'quarter'、'month'、'week'、'day'。如设置 'week-year'，则返回当前日期是所在年的第几周, 'day-week'，则返回当前日期是所在周的第几天。
+  */
+  export function GetDateCount<T extends Date | DateTime>(dateTime: T, metric: 'week-year'): Time;
+  // 按“星期几”获取指定日期范围内的日子。当输入为 DateTime 类型时，会把数据转到提供的时区的当地时间进行计算。target 取值范围 [1,2,3,4,5,6,7]
+  export function GetSpecificDaysOfWeek<T extends Date | DateTime>(startDate: T, endDate: T, target: List<Long>): List<T>;
 
-  // 列表（List）函数
+  /* 列表（List）函数 */
   export function Add<T, K extends T>(list: List<T>, item: K): void;
   export function AddAll<T>(list: List<T>, addList: List<T>): Decimal;
   export function Contains<T, K extends T>(list: List<T>, item: K): Boolean;
@@ -58,15 +70,15 @@ declare namespace nasl.util {
   export function ListReverse<T>(list: List<T>): void;
   export function ListSlice<T>(list: List<T>, start: Decimal, end: Decimal): List<T>;
   export function ListSort<T>(list: List<T>, by: (item: T) => any, sort: Boolean): void;
-  export function ListSum<T extends Integer | Decimal>(list: List<T>): T;
+  export function ListSum<T extends Long | Decimal>(list: List<T>): T;
   export function ListToMap<T, K extends Boolean | Decimal | Decimal | String, V>(map: List<T>, byKey: (elem: T) => K, byVal: (elem: T) => V): Map<K, V>;
   export function ListTransform<T0, T>(list: List<T0>, by: (elem: T0) => T): List<T>;
   export function Get<T>(list: List<T>, index: Decimal): T;
   export function Remove<T, K extends T>(list: List<T>, item: K): void;
-  export function RemoveAt<T>(list: List<T>, index: Integer): T;
+  export function RemoveAt<T>(list: List<T>, index: Long): T;
   export function Set<T, K extends T>(list: List<T>, index: Decimal, item: K): T;
 
-  // 映射（Map）函数
+  /* 映射（Map）函数 */
   export function MapContains<K, V>(map: Map<K, V>, key: K): Boolean;
   export function MapGet<K, V>(map: Map<K, V>, key: K): V;
   export function MapPut<K, V>(map: Map<K, V>, key: K, value: V): void;
@@ -74,61 +86,55 @@ declare namespace nasl.util {
   export function MapRemove<K, V>(map: Map<K, V>, key: K): void;
   export function MapValues<K, V>(map: Map<K, V>): List<V>;
 
-  // 枚举函数
-  /**
-  * @example nasl.util.EnumToList<app.enums.aEnum>();
+  /* 枚举函数，项目中可使用的枚举类型均定义在 app.enums 中 */
+  /** 将指定枚举转换枚举value和text的List集合
+  * @example nasl.util.EnumToList<app.enums.UserSourceEnum>();
   */
   export function EnumToList<T extends Enums>(): List<{ text: String, value: String; }>;
-  // 将指定枚举值转换为文本
-  export function EnumValueToText<T extends Enums>(value: any): String;
+  // 返回枚举指定value的标题字符串
+  export function EnumItemToText(value: Enums<Long | String>): String;
   // 在指定枚举中找到与参数相同的枚举值并返回
   export function StringToEnumValue<T extends Enums>(value: String): T;
 
-  // 数学函数
-  /**
-   * 整数/小数 操作
+  /* 数学函数 */
+  /** 整数/小数 操作
    * @param mode: 'HalfUp' | 'TowardsZero' | 'TowardsInfinity' === '四舍五入' | '截断、向零取整，如 -2.6 取整为 -2' | '进位、向正负无穷取整，如 -1.1 取整为 -2'
    */
   export function Round(value: Decimal, mode: 'HalfUp' | 'TowardsZero' | 'TowardsInfinity'): Decimal;
-
-  // 其他函数
+  /* 其他函数 */
   export function Clear<T>(struct: T): T;
   export function Clone<T>(struct: T): T;
+  // 判断参数是否为有效值，null、空字符串、纯空格、长度为0的集合均不被视为有效值，传入多个参数时，判断是否全部都是有效值 */
   export function HasValue(...args: Any[]): Boolean;
   // RandomInt 生成的数字为整数，如果需要指定位数的随机数，需要在数字前按照位数要求补 0
-  export function RandomInt(start: Integer, end: Integer): Integer;
+  export function RandomInt(start: Long, end: Long): Long;
 
   // New 系列函数使用
-  /**
-   * T 类型必填
+  /** 生成新的列表，T 类型必填
    * @example const variable1 = nasl.util.NewList<Boolean | Long>([true, false, 1])
    */
   export function NewList<T>(args: T[]): List<T>;
-  /**
-   * T 类型必填
+  /** 生成新的映射，K、T 类型必填
    * @example const variable1 = nasl.util.NewMap<String, Long>({'123': 456})
    */
   export function NewMap<K, T>(args: any): Map<K, T>;
-  /**
-   * T 类型必填
+  /** 生成新的数据实体，T 类型必填
    * class Entity1 { id: Long; property1: String; property2: String;}
    * @example const variable1 = nasl.util.NewEntity<Entity1>({id: 123, property1: '123', property2: '456'})
    */
   export function NewEntity<T>(arg: T): T;
-  /**
-   * T 类型必填
+  /** 生成新的结构体，T 类型必填
    * class Structure1 { id: Long; property1: String; property2: String;}
    * @example const variable1 = nasl.util.NewStructure<Structure1>({id: 123, property1: '123', property2: '456'})
    */
   export function NewStructure<T>(arg: T): T;
-  /**
+  /** 生成新的匿名结构体, 无需定义类型
    * @example const variable1 = nasl.util.NewAnonymousStructure({property1: '123', property2: '456'})
    */
   export function NewAnonymousStructure(arg: Any): Any;
 
   export function jsonSerialize(arg: Any): String;
-  /**
-   * T 为返回值类型，必填
+  /** JSON 反序列化, T 为返回值类型，必填
    * @example nasl.util.jsonDeserialize<Boolean>(variable1);
    */
   export function jsonDeserialize<T>(arg: String): T;