minigame-std
    Preparing search index...

    Function stat

    获取文件或目录的状态信息。

    文件或目录的路径。

    可选选项，包含 recursive 可递归获取目录下所有文件状态。

    包含状态信息的异步操作结果。

    1.0.0

    const result = await stat('/path/to/file.txt');
    if (result.isOk()) {
        const stats = result.unwrap();
        console.log(stats.isFile()); // true
    }

    • 获取单个文件或目录的状态信息。

      Parameters

      • path: string

        文件或目录的路径。

      • Optionaloptions: StatOptions & { recursive: false }

        可选选项，recursive 设置为 false（默认）获取单个文件状态。

      Returns AsyncIOResult<Stats>

      包含状态信息的异步操作结果。

      1.0.0

      const result = await stat('/path/to/file.txt');
      if (result.isOk()) {
          const stats = result.unwrap();
          console.log(stats.isFile()); // true
      }

    • 递归获取目录下所有文件和子目录的状态信息。

      Parameters

      • path: string

        目录的路径。

      • options: StatOptions & { recursive: true }

        选项，recursive 设置为 true 以递归获取。

      Returns AsyncIOResult<FileStats[]>

      包含所有文件状态信息数组的异步操作结果。

      1.0.0

      const result = await stat('/path/to/dir', { recursive: true });
      if (result.isOk()) {
          const fileStats = result.unwrap();
          fileStats.forEach(file => console.log(file.path));
      }

    • 获取单个文件或目录的状态信息。

      Parameters

      • path: string

        文件或目录的路径。

      • Optionaloptions: StatOptions

        可选选项，recursive 设置为 false（默认）获取单个文件状态。

      Returns AsyncIOResult<Stats | FileStats[]>

      包含状态信息的异步操作结果。

      1.0.0

      const result = await stat('/path/to/file.txt');
      if (result.isOk()) {
          const stats = result.unwrap();
          console.log(stats.isFile()); // true
      }

    Settings

    Member Visibility