Skip to content

Commit

Permalink
docs: 添加 isTruly() 方法的 API 文档;
Browse files Browse the repository at this point in the history
  • Loading branch information
yaohaixiao committed Feb 13, 2025
1 parent 9b5deb0 commit 9bef6c5
Show file tree
Hide file tree
Showing 55 changed files with 143 additions and 45 deletions.
43 changes: 41 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ Type: `Any`

Type: `Boolean`

'val' 是 NaN,返回 true,否则返回 false。
'val' 在布尔上下文中被视为 true 的值,返回 true,否则返回 false。

#### Example

Expand Down Expand Up @@ -348,6 +348,45 @@ Types.isNil(NaN) // => false
Types.isNil('') // => false
```

### [isTruly(val)](https://yaohaixiao.github.io/types.js/#method-isTruly)

isTruly(val) 方法用来检测测试数据是否为在布尔上下文中被视为 true 的值。

#### Parameters

##### val

Type: `Any`

必选,要检测的数据。

#### Returns

Type: `Boolean`

'val' 在布尔上下文中被视为 true 的值,返回 true,否则返回 false。

#### Example

```js
import Types from '@yaohaixiao/types.js'
// 或者单独引用 isTruly() 方法
// import isTruly from '@yaohaixiao/types.js/isTruly'

Types.isTruly(true); // -> true
Types.isTruly(1); // -> true
Types.isTruly("hello"); // -> true
Types.isTruly({}); // -> true
Types.isTruly([]); // -> true

Types.isTruly(false); // -> false
Types.isTruly(0); // -> false
Types.isTruly(''); // -> false
Types.isTruly(null); // -> false
Types.isTruly(undefined); // -> false
Types.isTruly(NaN); // -> false
```

### [isValue(val)](https://yaohaixiao.github.io/types.js/#method-isValue)

isValue(val) 方法用来检测测试数据是否为有效的数据。
Expand Down Expand Up @@ -3418,7 +3457,7 @@ Types.isUUID('A987FBC94BED3078CF079141BA07C9F') // -> false
```
### [DOM](https://yaohaixiao.github.io/types.js/#heading-88)
### [Element](https://yaohaixiao.github.io/types.js/#heading-88)
types.js 提供以下方法来检测 DOM 相关的数据类型。
Expand Down
38 changes: 38 additions & 0 deletions api/pug/Base/isTruly.pug
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
section.section
header.section__header
h3#method-isTruly.section__h3 isTruly(val)
div.section__content
dl.section__dl
dt.section__dt Since:
dd.section__dd 2.8.0
h4.section__h4 Description
p isTruly(val) 方法用来检测测试数据是否为在布尔上下文中被视为 true 的值。
h4.section__h4 Parameters
h5.section__h4 val
dl.section__dl
dt.section__dt Type:
dd.section__dd Any
p (必须)val 待检测的数据。
h4.section__h4 Returns
dl.section__dl
dt.section__dt Type:
dd.section__dd String。
p 'val' 在布尔上下文中被视为 true 的值,返回 true,否则返回 false。
pre.section__pre
code.section__code.
import Types from '@yaohaixiao/types.js'
// 或者单独引用 isTruly() 方法
// import isTruly from '@yaohaixiao/types.js/isTruly'

Types.isTruly(true); // -> true
Types.isTruly(1); // -> true
Types.isTruly("hello"); // -> true
Types.isTruly({}); // -> true
Types.isTruly([]); // -> true

Types.isTruly(false); // -> false
Types.isTruly(0); // -> false
Types.isTruly(''); // -> false
Types.isTruly(null); // -> false
Types.isTruly(undefined); // -> false
Types.isTruly(NaN); // -> false
1 change: 1 addition & 0 deletions api/pug/Base/section.pug
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ section.section
include ./is
include ./isFalsy
include ./isNil
include ./isTruly
include ./isValue
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions api/pug/DOM/section.pug → api/pug/Element/section.pug
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
section.section
header.section__header
h2.section__title DOM
h2.section__title Element
div.section__content
p types.js 提供以下方法来检测 DOM 相关的数据类型。
p types.js 提供以下方法来检测 Element 相关的数据类型。
include ./isElement
include ./isFragment
include ./isHTMLCollection
Expand Down
2 changes: 1 addition & 1 deletion api/pug/main.pug
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ main#main.main
include ./Function/section
include ./Number/section
include ./String/section
include ./DOM/section
include ./Element/section

include ./footer
19 changes: 17 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,22 @@

Types.isNil(NaN) // => false

Types.isNil('') // => false</code></pre></div></section><section class="section"><header class="section__header"><h3 class="section__h3" id="method-isValue">isValue(val)</h3></header><div class="section__content"><dl class="section__dl"><dt class="section__dt">Since:</dt><dd class="section__dd">0.2.0</dd></dl><h4 class="section__h4">Description</h4><p>isValue(val) 方法用来检测测试数据是否有效的数据(非null、undefined、NaN或者正负无穷数值)。</p><h4 class="section__h4">Parameters</h4><h5 class="section__h4">val</h5><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Any</dd></dl><p>(必须)val 待检测的数据。</p><h4 class="section__h4">Returns</h4><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Boolean。</dd></dl><p>true - 表示检测数据是否有效的数据(非null、undefined或者正负无穷数值),false 则表示不是。</p><pre class="section__pre"><code class="section__code">import Types from '@yaohaixiao/types.js'
Types.isNil('') // => false</code></pre></div></section><section class="section"><header class="section__header"><h3 class="section__h3" id="method-isTruly">isTruly(val)</h3></header><div class="section__content"><dl class="section__dl"><dt class="section__dt">Since:</dt><dd class="section__dd">2.8.0</dd></dl><h4 class="section__h4">Description</h4><p>isTruly(val) 方法用来检测测试数据是否为在布尔上下文中被视为 true 的值。</p><h4 class="section__h4">Parameters</h4><h5 class="section__h4">val</h5><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Any</dd></dl><p>(必须)val 待检测的数据。</p><h4 class="section__h4">Returns</h4><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">String。</dd></dl><p>'val' 在布尔上下文中被视为 true 的值,返回 true,否则返回 false。</p><pre class="section__pre"><code class="section__code">import Types from '@yaohaixiao/types.js'
// 或者单独引用 isTruly() 方法
// import isTruly from '@yaohaixiao/types.js/isTruly'

Types.isTruly(true); // -> true
Types.isTruly(1); // -> true
Types.isTruly("hello"); // -> true
Types.isTruly({}); // -> true
Types.isTruly([]); // -> true

Types.isTruly(false); // -> false
Types.isTruly(0); // -> false
Types.isTruly(''); // -> false
Types.isTruly(null); // -> false
Types.isTruly(undefined); // -> false
Types.isTruly(NaN); // -> false</code></pre></div></section><section class="section"><header class="section__header"><h3 class="section__h3" id="method-isValue">isValue(val)</h3></header><div class="section__content"><dl class="section__dl"><dt class="section__dt">Since:</dt><dd class="section__dd">0.2.0</dd></dl><h4 class="section__h4">Description</h4><p>isValue(val) 方法用来检测测试数据是否有效的数据(非null、undefined、NaN或者正负无穷数值)。</p><h4 class="section__h4">Parameters</h4><h5 class="section__h4">val</h5><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Any</dd></dl><p>(必须)val 待检测的数据。</p><h4 class="section__h4">Returns</h4><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Boolean。</dd></dl><p>true - 表示检测数据是否有效的数据(非null、undefined或者正负无穷数值),false 则表示不是。</p><pre class="section__pre"><code class="section__code">import Types from '@yaohaixiao/types.js'
// 或者单独引用 isValue() 方法
// import isValue from '@yaohaixiao/types.js/isValue'

Expand Down Expand Up @@ -1437,7 +1452,7 @@
Types.isUUID('') // -> false
Types.isUUID('xxxA987FBC9-4BED-3078-CF07-9141BA07C9F3') // -> false
Types.isUUID('934859') // -> false
Types.isUUID('A987FBC94BED3078CF079141BA07C9F') // -> false</code></pre></div></section></section><section class="section"><header class="section__header"><h2 class="section__title">DOM</h2></header><div class="section__content"><p>types.js 提供以下方法来检测 DOM 相关的数据类型。</p></div><section class="section"><header class="section__header"><h3 class="section__h3" id="method-isElement">isElement(val)</h3></header><div class="section__content"><dl class="section__dl"><dt class="section__dt">Since:</dt><dd class="section__dd">0.2.0</dd></dl><h4 class="section__h4">Description</h4><p>isElement(val) 方法用来检测测试数据是否为 Element 实例。</p><p>注意:isElement 调整后,是一个更通用的接口,它可以表示任何类型的元素节点,不仅包括 HTML 元素,还包括 SVG(可缩放矢量图形)元素、MathML(数学标记语言)元素等。</p><h4 class="section__h4">Parameters</h4><h5 class="section__h4">val</h5><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Any</dd></dl><p>(必须)val 待检测的数据。</p><h4 class="section__h4">Returns</h4><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Boolean。</dd></dl><p>true - 表示检测数据是 Element 实例,false 则表示不是。</p><pre class="section__pre"><code class="section__code">import Types from '@yaohaixiao/types.js'
Types.isUUID('A987FBC94BED3078CF079141BA07C9F') // -> false</code></pre></div></section></section><section class="section"><header class="section__header"><h2 class="section__title">Element</h2></header><div class="section__content"><p>types.js 提供以下方法来检测 Element 相关的数据类型。</p></div><section class="section"><header class="section__header"><h3 class="section__h3" id="method-isElement">isElement(val)</h3></header><div class="section__content"><dl class="section__dl"><dt class="section__dt">Since:</dt><dd class="section__dd">0.2.0</dd></dl><h4 class="section__h4">Description</h4><p>isElement(val) 方法用来检测测试数据是否为 Element 实例。</p><p>注意:isElement 调整后,是一个更通用的接口,它可以表示任何类型的元素节点,不仅包括 HTML 元素,还包括 SVG(可缩放矢量图形)元素、MathML(数学标记语言)元素等。</p><h4 class="section__h4">Parameters</h4><h5 class="section__h4">val</h5><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Any</dd></dl><p>(必须)val 待检测的数据。</p><h4 class="section__h4">Returns</h4><dl class="section__dl"><dt class="section__dt">Type:</dt><dd class="section__dd">Boolean。</dd></dl><p>true - 表示检测数据是 Element 实例,false 则表示不是。</p><pre class="section__pre"><code class="section__code">import Types from '@yaohaixiao/types.js'
// 或者单独引用 isElement() 方法
// import isElement from '@yaohaixiao/types.js/isElement'

Expand Down
Loading

0 comments on commit 9bef6c5

Please sign in to comment.