From e5fc8e02f1f523cd7d4ef9803bf6f40eeb06a1d7 Mon Sep 17 00:00:00 2001
From: Huan LI <zixia@zixia.net>
Date: Wed, 25 Mar 2020 01:06:42 +0800
Subject: [PATCH] add room.avatar() doc (#1923)

---
 src/user/room.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/user/room.ts b/src/user/room.ts
index dc2c2e92..5f92e119 100644
--- a/src/user/room.ts
+++ b/src/user/room.ts
@@ -1185,6 +1185,14 @@ export class Room extends Accessory implements Sayable {
     return owner
   }
 
+  /**
+   * Get avatar from the room.
+   * @returns {FileBox}
+   * @example
+   * const fileBox = await room.avatar()
+   * const name = fileBox.name
+   * fileBox.toFile(name)
+   */
   public async avatar (): Promise<FileBox> {
     log.verbose('Room', 'avatar()')
 
-- 
GitLab