docs(negate): Fix docs for negate

This commit is contained in:
Sojin Park 2024-07-14 18:14:23 +09:00
parent cdc3282060
commit 9b6bf6dfb4
3 changed files with 26 additions and 4 deletions

View File

@ -23,6 +23,4 @@ import { negate } from 'es-toolkit/function';
negate(() => true)(); // returns 'false'
negate(() => false)(); // returns 'false'
negate(() => 1); // returns 'false'
negate(() => 0); // returns 'true'
```

View File

@ -23,6 +23,4 @@ import { negate } from 'es-toolkit/function';
negate(() => true)(); // returns 'false'
negate(() => false)(); // returns 'false'
negate(() => 1); // returns 'false'
negate(() => 0); // returns 'true'
```

View File

@ -0,0 +1,26 @@
# negate
创建一个函数,它会否定给定谓词函数的结果。
## 签名
```typescript
function negate<F extends (...args: unknown[]) => boolean>(func: F): F;
```
### 参数
- `func` (`F extends (args: ...Parameters) => unknown`): 要否定的函数。
### 返回值
- (`F`): 返回新的否定函数。
## 示例
```typescript
import { negate } from 'es-toolkit/function';
negate(() => true)(); // 返回 'false'
negate(() => false)(); // 返回 'false'
```