add room.avatar() doc (#1923)

e5fc8e02 · Huan (李卓桓) · 2c5bb86c · e5fc8e02
隐藏空白更改
内联并排

Showing with 8 addition and 0 deletion

src/user/room.ts src/user/room.ts +8 -0

未找到文件。
--- 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()')