Class Gfs

constructor

• new Gfs(c, gid): Gfs

• Parameters

  • c: Client

  • gid: number

  Returns Gfs

Readonly gid

client

• get client(): Client

• 返回所属的客户端对象

  Returns Client

group

• get group(): Group

• 返回所在群的实例

  Returns Group

group_id

• get group_id(): number

• this.gid的别名

  Returns number

df

• df(): Promise<{
      free: number;
      total: number;
      used: number;
  } & {
      file_count: number;
      max_file_count: number;
  }>

• 获取使用空间和文件数

  Returns Promise<{
      free: number;
      total: number;
      used: number;
  } & {
      file_count: number;
      max_file_count: number;
  }>

dir

• dir(pid?, start?, limit?): Promise<(GfsFileStat | GfsDirStat)[]>

• 列出pid目录下的所有文件和目录

  Parameters

  • pid: string = "/"

    目标目录，默认为根目录，即"/"

  • start: number = 0

  • limit: number = 100

    文件/目录上限，超过此上限就停止获取，默认100

  Returns Promise<(GfsFileStat | GfsDirStat)[]>

  文件和目录列表

  Todo

  未知参数

download

• download(fid): Promise<Omit<FileElem, "type"> & {
      url: string;
  }>

• 获取文件下载地址

  Parameters

  • fid: string

    文件id

  Returns Promise<Omit<FileElem, "type"> & {
      url: string;
  }>

forward

• forward(stat, pid?, name?): Promise<GfsFileStat>

• 将文件转发到当前群

  Parameters

  • stat: GfsFileStat

    另一个群中的文件属性

  • pid: string = "/"

    转发的目标目录，默认根目录

  • Optional name: string

    转发后的文件名，默认不变

  Returns Promise<GfsFileStat>

  转发的文件在当前群的属性

ls

• ls(pid?, start?, limit?): Promise<(GfsFileStat | GfsDirStat)[]>

• dir 的别名

  Parameters

  • pid: string = "/"

  • start: number = 0

  • limit: number = 100

  Returns Promise<(GfsFileStat | GfsDirStat)[]>

mkdir

• mkdir(name): Promise<GfsDirStat>

• 创建目录(只能在根目录下创建)

  Parameters

  • name: string

  Returns Promise<GfsDirStat>

mv

• mv(fid, pid): Promise<void>

• 移动文件

  Parameters

  • fid: string

    要移动的文件id

  • pid: string

    目标目录id

  Returns Promise<void>

rename

• rename(fid, name): Promise<void>

• 重命名文件/目录

  Parameters

  • fid: string

    文件id

  • name: string

    新命名

  Returns Promise<void>

rm

• rm(fid): Promise<void>

• 删除文件/目录(删除目录会删除下面的所有文件)

  Parameters

  • fid: string

  Returns Promise<void>

stat

• stat(fid): Promise<GfsFileStat | GfsDirStat>

• 获取文件或目录属性

  Parameters

  • fid: string

    目标文件id

  Returns Promise<GfsFileStat | GfsDirStat>

upload

• upload(file, pid?, name?, callback?): Promise<GfsFileStat>

• 上传一个文件

  Parameters

  • file: string | Buffer | Uint8Array

    string表示从该本地文件路径上传，Buffer表示直接上传这段内容

  • pid: string = "/"

    上传的目标目录id，默认根目录

  • Optional name: string

    上传的文件名，file为Buffer时，若留空则自动以md5命名

  • Optional callback: ((percentage) => void)

    监控上传进度的回调函数，拥有一个"百分比进度"的参数

    • • (percentage): void

      • Parameters

        • percentage: string

        Returns void

  Returns Promise<GfsFileStat>

  上传的文件属性