minigame-std/docs/namespaces/fs/functions/stat.md

Mini Game Standard Development Library.

[**minigame-std**](../../../README.md)

***

[minigame-std](../../../README.md) / [fs](../README.md) / stat

# Function: stat()

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

## Param

文件或目录的路径。

## Param

可选选项。

## Call Signature

```ts
function stat(path): AsyncIOResult<Stats>
```

Defined in: [src/std/fs/fs\_async.ts:108](https://github.com/JiangJie/minigame-std/blob/fdb22241c47c2e98329a4c62befde728957e03ee/src/std/fs/fs_async.ts#L108)

### Parameters

| Parameter | Type |
| ------ | ------ |
| `path` | `string` |

### Returns

`AsyncIOResult`\<`Stats`\>

## Call Signature

```ts
function stat(path, options): AsyncIOResult<FileStats[]>
```

Defined in: [src/std/fs/fs\_async.ts:109](https://github.com/JiangJie/minigame-std/blob/fdb22241c47c2e98329a4c62befde728957e03ee/src/std/fs/fs_async.ts#L109)

### Parameters

| Parameter | Type |
| ------ | ------ |
| `path` | `string` |
| `options` | [`StatOptions`](../interfaces/StatOptions.md) & \{ `recursive`: `true`; \} |

### Returns

`AsyncIOResult`\<`FileStats`[]\>

## Call Signature

```ts
function stat(path, options?): AsyncIOResult<Stats | FileStats[]>
```

Defined in: [src/std/fs/fs\_async.ts:112](https://github.com/JiangJie/minigame-std/blob/fdb22241c47c2e98329a4c62befde728957e03ee/src/std/fs/fs_async.ts#L112)

### Parameters

| Parameter | Type |
| ------ | ------ |
| `path` | `string` |
| `options`? | [`StatOptions`](../interfaces/StatOptions.md) |

### Returns

`AsyncIOResult`\<`Stats` \| `FileStats`[]\>