index

接口

BaseTask

定义于: define-promise-tasks.ts:7

继承于

• SingleTasks
• ParallelTasks
• QueueTasks

属性

属性	类型	描述	定义于
type	"single" | "parallel" | "queue"	任务类型	define-promise-tasks.ts:9

---

ParallelTasks

定义于: define-promise-tasks.ts:19

继承

• BaseTask

属性

属性	类型	描述	重写了	定义于
tasks	Task[]	-	-	define-promise-tasks.ts:21
type	"parallel"	任务类型	BaseTask.type	define-promise-tasks.ts:20

---

PnpmWorkspace

定义于: types/pnpm-workspace.yaml.shim.ts:12

pnpm-workspace.yaml 文件的类型声明

Description

设计理由

主要是为了让该文件被解析后，能够有一个基础的类型声明

按理说这个东西应该有别人封装好的类型的，肯定因为我没找到。

未来应该找到这样的类型声明库，直接复用别人的就好了，不要自己写了。

属性

属性	类型	描述	定义于
catalog?	string[]	-	types/pnpm-workspace.yaml.shim.ts:21
packages?	string[]	包的匹配语法字符串 示例 ["packages/**", "demos/**", "utils"]	types/pnpm-workspace.yaml.shim.ts:19

---

QueueTasks

定义于: define-promise-tasks.ts:24

继承

• BaseTask

属性

属性	类型	描述	重写了	定义于
tasks	Task[]	-	-	define-promise-tasks.ts:26
type	"queue"	任务类型	BaseTask.type	define-promise-tasks.ts:25

---

SingleTasks

定义于: define-promise-tasks.ts:14

继承

• BaseTask

属性

属性	类型	描述	重写了	定义于
tasks	Task	-	-	define-promise-tasks.ts:16
type	"single"	任务类型	BaseTask.type	define-promise-tasks.ts:15

类型别名

Condition()

type Condition = (...args) => boolean;

定义于: conditions.ts:1

参数

参数	类型
...args	unknown[]

返回

boolean

---

Conditions

type Conditions = Condition[];

定义于: conditions.ts:4

已被弃用

没必要

---

Prettify<T>

type Prettify<T> = { [K in keyof T]: T[K] } & {};

定义于: types/Prettify.ts:5

Prettify 帮助程序是一种实用程序类型，它采用对象类型并使悬停叠加更具可读性。

类型参数

类型参数
T

参阅

https://www.totaltypescript.com/concepts/the-prettify-helper

---

PromiseTasksConfig

type PromiseTasksConfig = TasksConfig;

定义于: define-promise-tasks.ts:31

---

SimpleAsyncTask

type SimpleAsyncTask = ReturnType<typeof generateSimpleAsyncTask>;

定义于: simple-promise-tools.ts:19

---

Task

type Task = SimpleAsyncTask | TasksConfig;

定义于: define-promise-tasks.ts:12

---

TasksConfig

type TasksConfig = 
  | SingleTasks
  | ParallelTasks
  | QueueTasks;

定义于: define-promise-tasks.ts:29

---

TaskType

type TaskType = typeof taskTypes[number];

定义于: define-promise-tasks.ts:5

---

ToNumberLike<T>

type ToNumberLike<T> = T | `${T}`;

定义于: types/Prettify.ts:17

转换成 NumberLike 类型

类型参数

类型参数
T extends number

Description

设计理由

期望让一个数值类型的联合类型 变成NumberLike形式的类型

变量

initFlag

const initFlag: "initFlag";

定义于: simple-promise-tools.ts:21

---

taskTypes

const taskTypes: readonly ["single", "parallel", "queue"];

定义于: define-promise-tasks.ts:3

函数

definePromiseTasks()

function definePromiseTasks(config): TasksConfig

定义于: define-promise-tasks.ts:58

定义异步任务对象

参数

参数	类型
config	TasksConfig

返回

TasksConfig

Description

这个对象是一揽子异步任务的配置

---

executePromiseTasks()

function executePromiseTasks(config, lastParams): Promise<any>

定义于: define-promise-tasks.ts:81

执行异步函数对象

参数

参数	类型	默认值	描述
config	TasksConfig	undefined	-
lastParams	any	null	上一次递归执行时提供的参数 Description 考虑到递归函数 这里提供了一个参数 用于传递上一次递归执行的结果

返回

Promise<any>

---

generateSimpleAsyncTask()

function generateSimpleAsyncTask<T>(func): (...args) => Promise<ReturnType<T>>

定义于: simple-promise-tools.ts:5

创建简单的异步任务

类型参数

类型参数
T extends (...args) => any

参数

参数	类型
func	T

返回

Function

参数

参数	类型
...args	any

返回

Promise<ReturnType<T>>

---

isConditionsEvery()

function isConditionsEvery(conditions): boolean

定义于: conditions.ts:20

是否每一个条件函数都满足？

参数

参数	类型
conditions	Condition[]

返回

boolean

Description

设计理由

旨在于封装这样的代码段

const conditions = [
	() => !isEqual(nAssetRecord, oAssetRecord),
	() => !isEqual(nAssetRecord, defPropsAssets),
	() => isEdit.value || isInfo.value,
];
conditions.every((condition) => condition())

---

isConditionsSome()

function isConditionsSome(conditions): boolean

定义于: conditions.ts:24

参数

参数	类型
conditions	Condition[]

返回

boolean

---

runPromiseByConcurrency()

function runPromiseByConcurrency<T>(promises): Promise<void>

定义于: simple-promise-tools.ts:53

以并行的形式 并发运行异步函数

类型参数

类型参数
T

参数

参数	类型
promises	(...args) => Promise<T>[]

返回

Promise<void>

---

runPromiseByQueue()

function runPromiseByQueue<T>(promises): Promise<void>

定义于: simple-promise-tools.ts:43

以队列串行的形式 串行运行异步函数

类型参数

类型参数
T

参数

参数	类型
promises	(...args) => Promise<T>[]

返回

Promise<void>

Version

2

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史