Skip to content

docs(set): update type annotations to match implementation #1427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(set): update type annotations to match implementation #1427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe92dde
docs: correct value parameter type in docs to align with implementation
caseBread Sep 26, 2025
5731f8a
docs: correct return type docs to match actual default (object)
caseBread Sep 26, 2025
4324bce
chore: apply prettier
caseBread Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions docs/ja/reference/compat/object/set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,18 @@
## インターフェース

```typescript
function set<T extends object>(
obj: T,
path: string | number | symbol | Array<string | number | symbol>,
value: unknown
): T;
function set<T extends object>(obj: T, path: string | number | symbol | Array<string | number | symbol>, value: any): T;
```

### パラメータ

- `obj` (`T`): 値を設定するオブジェクト。
- `path` (`string | number | symbol | Array<string | number | symbol>`): 値を設定するプロパティのパス。
- `value` (`unknown`): 設定する値。
- `value` (`any`): 設定する値。

### 戻り値

(`T`): 修正されたオブジェクトを返します。T を指定しない場合は unknown です。
(`T`): 修正されたオブジェクトを返します。T を指定しない場合は object です。

## 例

Expand Down
10 changes: 3 additions & 7 deletions docs/ko/reference/compat/object/set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,18 @@
## 인터페이스

```typescript
function set<T extends object>(
obj: T,
path: string | number | symbol | Array<string | number | symbol>,
value: unknown
): T;
function set<T extends object>(obj: T, path: string | number | symbol | Array<string | number | symbol>, value: any): T;
```

### 파라미터

- `obj` (`T`): 값을 설정할 객체.
- `path` (`string | number | symbol | Array<string | number | symbol>`): 값을 설정할 프로퍼티 경로.
- `value` (`unknown`): 설정할 값.
- `value` (`any`): 설정할 값.

### 반환 값

(`T`): 수정된 객체를 반환해요. T를 지정하지 않으면 unknown이에요.
(`T`): 수정된 객체를 반환해요. T를 지정하지 않으면 object이에요.

## 예시

Expand Down
10 changes: 3 additions & 7 deletions docs/reference/compat/object/set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,18 @@ Sets the given value at the specified path of the object. If any part of the pat
## Signature

```typescript
function set<T extends object>(
obj: T,
path: string | number | symbol | Array<string | number | symbol>,
value: unknown
): T;
function set<T extends object>(obj: T, path: string | number | symbol | Array<string | number | symbol>, value: any): T;
```

### Parameters

- `obj` (`T`): The object to modify.
- `path` (`string | number | symbol | Array<string | number | symbol>`): The path of the property to set.
- `value` (`unknown`): The value to set.
- `value` (`any`): The value to set.

### Returns

(`T`): Returns the modified object. If T is not specified, it defaults to unknown.
(`T`): Returns the modified object. If T is not specified, it defaults to object.

## Examples

Expand Down
10 changes: 3 additions & 7 deletions docs/zh_hans/reference/compat/object/set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,18 @@
## 签名

```typescript
function set<T extends object>(
obj: T,
path: string | number | symbol | Array<string | number | symbol>,
value: unknown
): T;
function set<T extends object>(obj: T, path: string | number | symbol | Array<string | number | symbol>, value: any): T;
```

### 参数

- `obj` (`T`): 要修改的对象。
- `path` (`string | number | symbol | Array<string | number | symbol>`): 要设置的属性路径。
- `value` (`unknown`): 要设置的值。
- `value` (`any`): 要设置的值。

### 返回值

(`T`): 返回修改后的对象。如果未指定 T，默认值为 unknown。
(`T`): 返回修改后的对象。如果未指定 T，默认值为 object。

## 示例

Expand Down