From d486ee36769951a9e1110eabad922bf3d9c4f588 Mon Sep 17 00:00:00 2001
From: jarvisjiang <jarvisjiang@tencent.com>
Date: Tue, 14 May 2024 02:04:26 +0000
Subject: [PATCH] add docs for exported symbols

---
 src/mod.ts | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/mod.ts b/src/mod.ts
index ae2fe3c..8b7fe5e 100644
--- a/src/mod.ts
+++ b/src/mod.ts
@@ -5,7 +5,23 @@ export { None, Some, type Option } from './enum/option.ts';
 export { Err, Ok, type Result } from './enum/result.ts';
 
 // export some commonly used types
+
+/**
+ * The shorthand of Promise<Option<T>>.
+ */
 export type AsyncOption<T> = Promise<Option<T>>;
+
+/**
+ * The shorthand of Promise<Result<T, E>>.
+ */
 export type AsyncResult<T, E> = Promise<Result<T, E>>;
+
+/**
+ * The shorthand of Result<T, Error>.
+ */
 export type IOResult<T> = Result<T, Error>;
+
+/**
+ * The shorthand of Promise<Result<T, Error>>.
+ */
 export type AsyncIOResult<T> = Promise<IOResult<T>>;