diff --git a/src/index.jsx b/src/index.jsx index 8f8c1cd..48b8d43 100644 --- a/src/index.jsx +++ b/src/index.jsx @@ -5,7 +5,7 @@ banner: btns: - { name: '开 始', href: '/docs/quickstart.html', primary: true } - { name: 'Github >', href: 'https://github.com/buession/buession-prototype' } - caption: '当前版本: v2.2.2' + caption: '当前版本: v3.0.0' features: - { name: '优雅', desc: '旨在提供便捷的、可靠的基于原生 JavaScript/TypeScript 扩展的类库,拥有完善的文档和高可读性的源码' } - { name: '易用', desc: '觉大部分 API 基于原生 JavaScript/TypeScript 对象/类的扩展,参考学习 prototype.js' } diff --git a/src/manual/3.0/array.md b/src/manual/3.0/array.md new file mode 100644 index 0000000..5278bf0 --- /dev/null +++ b/src/manual/3.0/array.md @@ -0,0 +1,459 @@ +# Array 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [isEmpty](array.html#isempty) | 判断数组是否为空数组 | +| [exists](array.html#existsitem-any) | 判断元素 item 是否在数组中 | +| [first](array.html#first) | 获取数组第一个元素 | +| [last](array.html#last) | 获取数组最后一个元素 | +| [each](array.html#eachcallback-value-t,-index-number,-array-readonly-t[]-=>-void,-thisarg?-any) | 按顺序为数组中的每个元素调用一次函数 | +| [size](array.html#last) | 获取数组大小 | +| [merge](array.html#merge...items-t[]) | 连接两个或多个数组 | +| [compact](array.html#compact) | 返回一个不包含 null/undefined 值元素的数组的新版本 | +| [unique](array.html#unique) | 对数组的元素进行去重 | +| [without](array.html#withoutvalues-t[]) | 返回不包括参数中任意一个指定值的数组 | +| [clone](array.html#clone) | 克隆数组 | +| [clear](array.html#clear) | 清空数组 | + + +--- + + +### **isEmpty()** +* 类型:`Function` + +* 功能描述:判断数组是否为空数组 + +* 参数:无 + +* 返回值:`boolean` 数组为空,返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **exists(item: any)** +* 类型:`Function` + +* 功能描述:判断元素 item 是否在数组中 + +* 参数:item - `any` 待检测元素 + +* 返回值:`boolean` 元素 item 是否在数组中返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **first()** +* 类型:`Function` + +* 功能描述:获取数组第一个元素 + +* 参数:无 + +* 返回值:`any` 数组第一个元素 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **last()** +* 类型:`Function` + +* 功能描述:获取数组最后一个元素 + +* 参数:无 + +* 返回值:`any` 数组最后一个元素 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **each(callback: (value: T, index: number, array: readonly T[]) => void, thisArg?: any)** +* 类型:`Function` + +* 功能描述:按顺序为数组中的每个元素调用一次函数,[forEach](https://www.w3school.com.cn/jsref/jsref_foreach.asp)的别名 + +* 参数:callback - `(value: T, index: number, array: readonly T[]) => void as Function` callback 为数组中的每个元素运行的函数,其中:value 为前元素的值,index 为当前元素的数组索引,array 为当前元素所属的数组对象 + `any` thisArg 可选。要传递给函数以用作其 "this" 值的值,如果此参数为空,则值 "undefined" 将作为其 "this" 值传递 + +* 返回值:`void` + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **size()** +* 类型:`Function` + +* 功能描述:获取数组大小 + +* 参数:无 + +* 返回值:`number` 数组大小 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **merge(...items: T[])** +* 类型:`Function` + +* 功能描述:连接两个或多个数组 + +* 参数:items - `any as T` 待连接的 T 类型的数组 + +* 返回值:`Array` 已连接数组的副本 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **compact()** +* 类型:`Function` + +* 功能描述:返回一个不包含 null/undefined 值元素的数组的新版本 + +* 参数:无 + +* 返回值:`Array` 不包含 null/undefined 值元素的数组的新版本 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **unique()** +* 类型:`Function` + +* 功能描述:对数组的元素进行去重 + +* 参数:无 + +* 返回值:`Array` 数组元素进行去重后的新版本 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **without(values: T[])** +* 类型:`Function` + +* 功能描述:返回不包括参数中任意一个指定值的数组 + +* 参数:values - `any as T[]` 排除值数组 + +* 返回值:`Array` 不包括参数中任意一个指定值的数组 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **clone()** +* 类型:`Function` + +* 功能描述:克隆数组 + +* 参数:无 + +* 返回值:`Array` 克隆结果 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **clear()** +* 类型:`Function` + +* 功能描述:清空数组 + +* 参数:无 + +* 返回值:`Array` 空数组 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/browser.md b/src/manual/3.0/browser.md new file mode 100644 index 0000000..5496e1a --- /dev/null +++ b/src/manual/3.0/browser.md @@ -0,0 +1,318 @@ +# HttpCookie 参考手册 + + +### 属性 + +| 属性 | 描述 | +| ---- | ---- | +| [userAgent](browser.html#readonly-userAgent) | 获取浏览器 User-Agent | +| [name](browser.html#readonly-name) | 获取浏览器应用程序名称 | +| [isMobile](browser.html#readonly-isMobile) | 是否为移动设备 | +| [isChrome](browser.html#readonly-isChrome) | 是否为 Chrome 浏览器 | +| [isFirefox](browser.html#readonly-isFirefox) | 是否为 Firefox 浏览器 | +| [isMozilla](browser.html#readonly-isMozilla) | 是否为 Mozilla 浏览器 | +| [isMSIE](browser.html#readonly-isMSIE) | 是否为 IE 浏览器 | +| [isOpera](browser.html#readonly-isOpera) | 是否为 Opera 浏览器 | +| [isSafari](browser.html#readonly-Safari) | 是否为 Safari 浏览器 | +| [isNetscape](browser.html#readonly-Netscape) | 是否为 Netscape 浏览器 | + + +--- + + +### **readonly userAgent** +* 类型:`Property` + +* 功能描述:获取浏览器 User-Agent,等价于 `navigator.userAgent` + +* 返回值:`string` 浏览器 User-Agent + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **readonly name** +* 类型:`Property` + +* 功能描述:获取浏览器应用程序名称,等价于 `navigator.appName` + +* 返回值:`string` 浏览器应用程序名称 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **readonly isMobile** +* 类型:`Property` + +* 功能描述:是否为移动设备,检测依据:User-Agent 中含有 Android、iPhone、iPod、Windows Phone、Mobile、Coolpad、mmp、SmartPhone、midp、wap、xoom、Symbian、J2ME、Blackberry、Wince 其中任意一个字符串 + +* 返回值:`boolean` 是移动设备返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **readonly isChrome** +* 类型:`Property` + +* 功能描述:是否为 Chrome 浏览器 + +* 返回值:`boolean` 是 Chrome 浏览器返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **readonly isFirefox** +* 类型:`Property` + +* 功能描述:是否为 Firefox 浏览器 + +* 返回值:`boolean` 是 Firefox 浏览器返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **readonly isMSIE** +* 类型:`Property` + +* 功能描述:是否为 IE 浏览器 + +* 返回值:`boolean` 是 IE 浏览器返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **readonly isOpera** +* 类型:`Property` + +* 功能描述:是否为 Opera 浏览器 + +* 返回值:`boolean` 是 Opera 浏览器返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **readonly isSafari** +* 类型:`Property` + +* 功能描述:是否为 Safari 浏览器 + +* 返回值:`boolean` 是 Safari 浏览器返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **readonly isNetscape** +* 类型:`Property` + +* 功能描述:是否为 Netscape 浏览器 + +* 返回值:`boolean` 是 Netscape 浏览器返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/cookie.md b/src/manual/3.0/cookie.md new file mode 100644 index 0000000..846eac9 --- /dev/null +++ b/src/manual/3.0/cookie.md @@ -0,0 +1,124 @@ +# Cookie 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [set](cookie.html#setname-string,-value-string-|-null-|-undefined,-options?-cookieoptions) | 设置 Cookie | +| [get](cookie.html#getname-string) | 获取 Cookie | +| [delete](cookie.html#ddeletename-string,-options?-cookieoptions) | 删除 Cookie | + + +--- + + +### **set(name: string, value: string | null | undefined, options?: CookieOptions)** +* 类型:`Function` + +* 功能描述:设置 Cookie + +* 参数:name - `string` Cookie 名称 + value - `string | null | undefined` Cookie 值 + options - `CookieOptions` Cookie 选项 + +* 返回值:`string` Cookie 字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **get(name: string)** +* 类型:`Function` + +* 功能描述:获取 Cookie 值 + +* 参数:name - `string` Cookie 名称 + +* 返回值:`string | null` Cookie 值 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **delete(name: string, options?: CookieOptions)** +* 类型:`Function` + +* 功能描述:删除 Cookie + +* 参数:name - `string` Cookie 名称 + options - `CookieOptions` Cookie 选项 + +* 返回值:无 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/date.md b/src/manual/3.0/date.md new file mode 100644 index 0000000..1c17f93 --- /dev/null +++ b/src/manual/3.0/date.md @@ -0,0 +1,253 @@ +# Date 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [isLeapYear](date.html#isleapyear) | 判断是否为闰年 | +| [getSeason](date.html#getseason) | 获取季节 | +| [getDayOfYear](date.html#getdayofyear) | 获取年份中的第几天 | +| [getDaysOfYear](date.html#getdaysofyear) | 获取年份总天数 | +| [format](date.html#formatformat-string) | 将日期时间格式化为字符串 | + + +--- + + +### **isLeapYear()** +* 类型:`Function` + +* 功能描述:判断是否为闰年 + +* 参数:无 + +* 返回值:`boolean` 是闰年,返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **getSeason()** +* 类型:`Function` + +* 功能描述:获取季节 + +* 参数:无 + +* 返回值:`number` 依次返回 0 至 3 的整数,表示春季、夏季、秋季、冬季 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **getDayOfYear()** +* 类型:`Function` + +* 功能描述:获取年份中的第几天 + +* 参数:无 + +* 返回值:`number` 年份中的第几天 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **getDaysOfYear()** +* 类型:`Function` + +* 功能描述:获取年份总天数 + +* 参数:无 + +* 返回值:`number` 年份总天数 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **format(format: string)** +* 类型:`Function` + +* 功能描述:将日期时间格式化为字符串 + +* 参数:format - `String` format 格式字符串 + + y - 年 + + n - 季度(1 到 4) + + N - 季度名称 + + A - 季度中文名称 + + M - 月 + + f - 月(Jan 到 Dec) + + F - 月(January 到 December) + + C - 月,中文名称 + + d - 日 + + Y - 年份中的第几天(0 到 365) + + T - 月份有几天(28 到 30) + + j - 每月天数后面的英文后缀(st,nd,rd 或者 th) + + e - 星期几,数字表示,0(表示星期天)到 6(表示星期六) + + E - 星期几,数字表示,1(表示星期一)到 7(表示星期天) + + l - 星期几,文本表示,3 个字母(Mon 到 Sun) + + L - 星期几,完整的文本格式(Sunday 到 Saturday) + + w - 星期几,中文名称 + + W - 一月中第几个星期几 + + i - 月份中的第几周 + + o - 年份中的第几周 + + h - 小时(1~12) + + H - 小时(0~23) + + m - 分 + + s - 秒 + + S - 毫秒 + + a - 上午/下午标记 + + O - 与格林威治时间相差的小时数 + + P - 与格林威治时间相差的小时数,小时和分钟之间有冒号分隔 + + Z - 时区 + +* 返回值:`string` 格式化后的日期时间 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/document.md b/src/manual/3.0/document.md new file mode 100644 index 0000000..86c9fc5 --- /dev/null +++ b/src/manual/3.0/document.md @@ -0,0 +1,199 @@ +# Document 参考手册 + + +### 属性 + +| 属性 | 描述 | +| ---- | ---- | +| [fullScreen](document.html#readonly-fullscreen) | 检测当前文档是否全屏 | +| [fullScreenEnabled](document.html#readonly-fullscreenenabled) | 检测当前浏览器是否支持全屏模式 | +| [fullScreenElement](document.html#readonly-fullscreenelement) | 检测当前文档中正在以全屏模式显示的 Element 节点 | +| [fullScreen](document.html#readonly-fullscreen) | 检测当前文档是否全屏 | +| [httpCookie](cookie.html) | Cookie 对象操作 | + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [requestFullscreen](document.html#readonly-fullscreenelement) | 请求进入全屏模式 | +| [exitFullscreen](document.html#exitfullscreen) | 退出全屏模式 | + + +--- + + +### **readonly fullScreen** +* 类型:`Property` + +* 功能描述:检测当前文档是否全屏 + +* 参数:无 + +* 返回值:`boolean` 当前文档是否全屏,返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **readonly fullScreenEnabled** +* 类型:`Property` + +* 功能描述:检测当前浏览器是否支持全屏模式 + +* 返回值:`boolean` 当前浏览器是否支持全屏模式返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **readonly fullScreenElement** +* 类型:`Property` + +* 功能描述:检测当前文档中正在以全屏模式显示的 Element 节点 + +* 返回值:`boolean` 当前文档中正在以全屏模式显示的 Element 节点,返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **requestFullscreen()** +* 类型:`Function` + +* 功能描述:请求进入全屏模式 + +* 参数:无 + +* 返回值:`Promise` Promise + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **exitFullscreen()** +* 类型:`Function` + +* 功能描述:退出全屏模式 + +* 参数:无 + +* 返回值:`Promise` Promise + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/function.md b/src/manual/3.0/function.md new file mode 100644 index 0000000..2b61fff --- /dev/null +++ b/src/manual/3.0/function.md @@ -0,0 +1,96 @@ +# Function 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [argumentNames](function.html#argumentnames...args-any) | 获取函数参数名称 | +| [delay](function.html#delaytimeout-number) | 延时执行函数 | + + +--- + + +### **argumentNames(...args: any)** +* 类型:`Function` + +* 功能描述:获取函数参数名称 + +* 参数:args - `any` 1个或多个任意类型的可变参数可变参数 + +* 返回值:`string[] | null` 函数参数名称列表 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **delay(timeout: number)** +* 类型:`Function` + +* 功能描述:延时执行函数 + +* 参数:timeout - `number` 延时时间(单位:秒) + +* 返回值:`any` 函数返回值 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/index.md b/src/manual/3.0/index.md new file mode 100644 index 0000000..0526783 --- /dev/null +++ b/src/manual/3.0/index.md @@ -0,0 +1,18 @@ +# API + + +Buession Prototype API 包含以下目录: + + +#### [Prototype](prototype.md) +#### [Try](try.md) +#### [Optional](optional.md) +#### [Array](array.md) +#### [Date](date.md) +#### [Document](document.md) +#### [Function](function.md) +#### [Math](math.md) +#### [Number](number.md) +#### [Object](object.md) +#### [String](string.md) +#### [Window](window.md) \ No newline at end of file diff --git a/src/manual/3.0/location.md b/src/manual/3.0/location.md new file mode 100644 index 0000000..2e49b5f --- /dev/null +++ b/src/manual/3.0/location.md @@ -0,0 +1,84 @@ +# Location 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [getParameters](location.html#getParameters) | 获取所有的请求参数及值 | +| [getParameter](location.html#getseason) | 获取指定请求参数的值 | + + +--- + + +### **getParameters()** +* 类型:`Function` + +* 功能描述:获取所有的请求参数及值 + +* 参数:无 + +* 返回值:`Record` 当前请求 URL 中的所有的请求参数及值 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **getParameter(name: string)** +* 类型:`Function` + +* 功能描述:获取指定请求参数的值 + +* 参数:`string` 参数名称 + +* 返回值:`any` 请求参数的值 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/math.md b/src/manual/3.0/math.md new file mode 100644 index 0000000..929f531 --- /dev/null +++ b/src/manual/3.0/math.md @@ -0,0 +1,48 @@ +# Function 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [rand](math.html#randmin-number,-max?-number) | 延时执行函数 | + + +--- + + +### **rand(min: number, max?: number)** +* 类型:`Function` + +* 功能描述:产生一个指定范围内的随机数 + +* 参数:min - `number` 返回的最低值 + max - `number` 返回的最高值 + +* 返回值:`number` 随机数 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/number.md b/src/manual/3.0/number.md new file mode 100644 index 0000000..dce0099 --- /dev/null +++ b/src/manual/3.0/number.md @@ -0,0 +1,166 @@ +# Number 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [toPaddedString](number.html#topaddedstringlength-number,-radix-number) | 延时执行函数 | +| [isOdd](number.html#isoddnum-number) | 判断数字是否为奇数 | +| [isEven](number.html#isevennum-number) | 判断数字是否为偶数 | +| [isBetween](number.html#isbetweennum-number,-min-number,-max-number,-match?-boolean) | 判断一个数字是否在另两个数字之间 | + + +--- + + +### **toPaddedString(length: number, radix: number)** +* 类型:`Function` + +* 功能描述:数字填充 + +* 参数:length - `number` 长度 + radix - `number` 进制 + +* 返回值:`string` 填充后的字符串数字 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isOdd(num: number)** +* 类型:`Function` + +* 功能描述:判断数字是否为奇数 + +* 参数:num - `number` 需要判断的数字 + +* 返回值:`boolean` 数字是为奇数返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isEven(num: number)** +* 类型:`Function` + +* 功能描述:判断数字是否为偶数 + +* 参数:num - `number` 需要判断的数字 + +* 返回值:`boolean` 数字是为偶数返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isBetween(num: number, min: number, max: number, match?: boolean | undefined)** +* 类型:`Function` + +* 功能描述:判断一个数字是否在另两个数字之间 + +* 参数:num - `number` 需要判断的数字 + min - `number` 最小值 + max - `number` 最大值 + match - `boolean | undefined` 是否包含最小值或最大值 + +* 返回值:`boolean` 数字是否在另两个数字之间,返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/object.md b/src/manual/3.0/object.md new file mode 100644 index 0000000..4d88af0 --- /dev/null +++ b/src/manual/3.0/object.md @@ -0,0 +1,955 @@ +# Object 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [type](object.html#typeobj-any) | 获取对象数据类型 | +| [rawType](object.html#rawtypeobj-any) | 获取对象原始数据类型 | +| [isObject](object.html#isobjectobj-any) | 判断对象是否为 object 类型 | +| [isPlainObject](object.html#isplainobjectobj-any) | 判断对象是否为简单 object 类型 | +| [isMap](object.html#ismapobj-any) | 判断对象是否为 Map 类型 | +| [isSet](object.html#issetobj-any) | 判断对象是否为 Set 类型 | +| [isSymbol](object.html#issymbolobj-any) | 判断对象是否为 Symbol | +| [isPromise](object.html#ispromiseobj-any) | 判断对象是否为 Promise | +| [isPrimitive](object.html#isprimitiveobj-any) | 判断对象是否为原始类型 | +| [isFunction](object.html#isfunctionobj-any) | 判断对象是否为函数 | +| [isArray](object.html#isarrayobj-any) | 判断对象是否为数组 | +| [isString](object.html#isstringobj-any) | 判断对象是否为字符串对象 | +| [isNumber](object.html#isnumberobj-any) | 判断对象是否为数字对象 | +| [isBoolean](object.html#isbooleanobj-any) | 判断对象是否为布尔对象 | +| [isRegExp](object.html#isregexpobj-any) | 判断对象是否为正则对象 | +| [isFile](object.html#isfileobj-any) | 判断对象是否为文件对象 | +| [isWindow](object.html#iswindowobj-any) | 判断对象是否为 windows 对象 | +| [isElement](object.html#iselementobj-any) | 判断对象是否为 Element | +| [isEvent](object.html#iseventobj-any) | 判断对象是否为事件对象 | +| [isNull](object.html#isnullobj-any) | 判断对象是否为 null 对象 | +| [isUndefined](object.html#isundefinedobj-any) | 判断对象是否为未定义 | +| [isUndefinedOrNull](object.html#isundefinedornullobj-any) | 判断对象是否为未定义或 null | +| [equals](object.html#equalsobj1-any,-obj2-any) | 深度判断两个对象是否相等 | +| [clone](object.html#cloneobj-any) | 克隆对象 | +| [omit](object.html#omitobj-t,-...fields-k[]) | 克隆对象,但支持删除指定属性 | + + +--- + + +### **type(obj: any)** +* 类型:`Function` + +* 功能描述:获取对象数据类型 + +* 参数:obj - `any` 对象变量 + +* 返回值:`string` 对象数据类型 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **rawType(obj: any)** +* 类型:`Function` + +* 功能描述:获取对象原始数据类型 + +* 参数:obj - `any` 对象变量 + +* 返回值:`string` 原始数据类型 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isObject(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为 object 类型 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为 object 类型返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isPlainObject(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为简单 object 类型 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为简单 object 类型返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isMap(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为 Map 类型 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为 Map 类型返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isSet(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为 Map 类型 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为 Set 类型返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isSymbol(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为 Symbol + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为 Symbol 返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isPromise(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为 Promise + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为 Promise 返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isPrimitive(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为原始类型 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为原始类型返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isFunction(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为函数 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为函数返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isArray(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为数组 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为数组返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isString(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为字符串对象 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为字符串返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isNumber(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为数字对象 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为数字对象返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isBoolean(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为布尔对象 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象为布尔对象返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isRegExp(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为正则对象 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象是否为正则对象返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isFile(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为文件对象 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象是否为文件对象返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isWindow(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为 windows 对象 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象是否为 windows 对象返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isElement(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为 Element + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象是否为 Element 返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isEvent(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为事件对象 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象是否为事件对象返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isNull(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为 null + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象是否为 null 返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isUndefined(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为未定义 + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象是否为未定义返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isUndefinedOrNull(obj: any)** +* 类型:`Function` + +* 功能描述:判断对象是否为未定义或 null + +* 参数:obj - `any` 对象变量 + +* 返回值:`boolean` 对象是否为未定义或 null 返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **equals(obj1: any, obj2: any)** +* 类型:`Function` + +* 功能描述:深度判断两个对象是否相等 + +* 参数:obj1 - `any` 一个对象 + obj2 - `any` 用于和 obj1 比较的对象 + +* 返回值:`boolean` 当两个对象相等时,返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **clone(obj: any)** +* 类型:`Function` + +* 功能描述:克隆对象 + +* 参数:obj - `any` 对象变量 + +* 返回值:`any` 新对象实例 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **omit(obj: T, ...fields: K[])** +* 类型:`Function` + +* 功能描述:克隆对象,但支持删除指定属性 + +* 参数:obj - `object` 任意对象 + fields - `K[]` 需要删除的属性 + +* 返回值:`any` 新对象实例 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/optional.md b/src/manual/3.0/optional.md new file mode 100644 index 0000000..696502d --- /dev/null +++ b/src/manual/3.0/optional.md @@ -0,0 +1,246 @@ +# Optional 参考手册 + + +Optional 类是一个可以为 null 或 undefined 的容器对象,如果值 value 存在则 isPresent() 方法会返回 true,调用 get() 方法会返回 value 的值。 +其设计思想,参考 [java8 的 Optional](https://blog.51cto.com/turnsole/2120847) + + +使用方式,在构造函数中传入任意类型值;Optional 提供很多有用的方法,这样我们就不用显式进行 null 值和 undefined 的检测。 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [of](optional.html#static-ofvalue-t) | 返回一个指定 T 类型的值的 Optional 实例 | +| [ofNullable](optional.html#static-ofnullablevalue-t) | 如果为非 null 或 undefined,返回 Optional 描述的指定值的实例,否则返回空的 Optional 实例 | +| [empty](optional.html#static-empty) | 返回空的 Optional 实例 | +| [get](optional.html#get) | 如果 value 不为 null 或 undefined,则返回 value 的值;否则抛出异常 | +| [orElse](optional.html#orelseother-t) | 如果 value 不为 null 或 undefined,则返回 value 的值;否则返回 other | +| [isPresent](optional.html#ispresent) | 如果 value 不为 null 或 undefined,则返回 true;否则返回 false | + + +--- + + +```javascript + +``` + +### **static of(value: T)** +* 类型:`Function` + +* 功能描述:返回一个指定 T 类型的值的 Optional 实例 + +* 参数:value - `any of T` 任意类型的值 + +* 返回值:`Object` T 类型的值的 Optional 实例 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **static ofNullable(value: T)** +* 类型:`Function` + +* 功能描述:如果为非 null 或 undefined,返回 Optional 描述的指定值的实例,否则返回空的 Optional 实例 + +* 参数:value - `any as T` 任意类型的值 + +* 返回值:`Object` T 类型的值的 Optional 实例,或空的 Optional 实例 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **static empty()** +* 类型:`Function` + +* 功能描述:返回空的 Optional 实例 + +* 参数:无 + +* 返回值:`Object as Optional` 空的 Optional 实例 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **get()** +* 类型:`Function` + +* 功能描述:如果 value 不为 null 或 undefined,则返回 value 的值;否则抛出异常 + +* 参数:无 + +* 返回值:`any as T` Optional 中包含这个值 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **orElse(other: T)** +* 类型:`Function` + +* 功能描述:如果 value 不为 null 或 undefined,则返回 value 的值;否则返回 other + +* 参数:other - `any of T` 任意类型的值 + +* 返回值:`any as T` value 不为 null 或 undefined,则返回 value 的值;否则返回 other + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + +### **isPresent()** +* 类型:`Function` + +* 功能描述:如果 value 不为 null 或 undefined,则返回 true;否则返回 false + +* 参数:无 + +* 返回值:`boolean` value 不为 null 或 undefined,则返回 true;否则返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/prototype.md b/src/manual/3.0/prototype.md new file mode 100644 index 0000000..318e28b --- /dev/null +++ b/src/manual/3.0/prototype.md @@ -0,0 +1,125 @@ +# Prototype 参考手册 + + +### 属性 + +| 属性 | 描述 | +| ---- | ---- | +| [version](prototype.html#version) | 获取 Buession Prototype 版本 | + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [emptyFunction](prototype.html#emptyFunction) | 执行一个空方法 | +| [K](prototype.html#K) | 返回参数传递的任意值 | + + +--- + + +### **version** +* 类型:`String` + +* 功能描述:获取 Buession Prototype 版本 + +* 返回值:Buession Prototype 版本 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + Prototype 版本:{Prototype.version} + + + + +``` + + +### **emptyFunction()** +* 类型:`Function` + +* 功能描述:执行一个空方法 + +* 参数:无 + +* 返回值:void + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **K(x: any)** +* 类型:`Function` + +* 功能描述:返回参数传递的任意值 + +* 参数:x - `any` 任意值 + +* 返回值:`any` 参数传递的任意值 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/string.md b/src/manual/3.0/string.md new file mode 100644 index 0000000..23c5e19 --- /dev/null +++ b/src/manual/3.0/string.md @@ -0,0 +1,946 @@ +# String 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [exists](string.html#existsstr-string) | 判断字符串是否存在 | +| [equals](string.html#equalsstr-string-|-undefined-|-null) | 判断字符串是否相等 | +| [equalsIgnoreCase](string.html#equalsignorecasestr-string-|-undefined-|-null) | 判断字符串是否相等,不考虑大小写 | +| [isEmpty](string.html#isempty) | 判断是否为空字符串 | +| [isNotEmpty](string.html#isnotempty) | 判断是否不为空字符串 | +| [isBlank](string.html#isblank) | 判断是否为空白字符串 | +| [repeat](string.html#repeatcount-number) | 重复一个字符串 | +| [left](string.html#leftlength-number) | 截取字符串左边边指定数目的字符串 | +| [right](string.html#rightlength-number) | 截取字符串右边指定数目的字符串 | +| [truncation](string.html#truncationlength-number,-truncation-string) | 截取字符串,超出部分用 truncation 替代 | +| [ltrim](string.html#ltrim) | 删除字符串开头的空白字符 | +| [rtrim](string.html#rtrim) | 删除字符串结尾的空白字符 | +| [startsWith](string.html#startswithstr-string) | 判断字符串是否以给定的字符串开头 | +| [endsWith](string.html#endswithstr-string) | 判断字符串是否以给定的字符串结尾 | +| [lcfirst](string.html#lcfirst) | 首字母小写 | +| [ucfirst](string.html#ucfirst) | 首字母大写 | +| [escapeHTML](string.html#escapehtml) | 将 HTML 编码 | +| [unescapeHTML](string.html#unescapehtml) | 将 HTML 实体字符解码 | +| [stripTag](string.html#striptagtag-string) | 删除 HTML 标签 | +| [stripTags](string.html#striptagstag-string) | 批量删除 HTML 标签 | +| [stripScripts](string.html#stripscripts) | 删除 script 标签 | +| [toArray](string.html#toarraydelimiter-string) | 将字符串转换为数组 | +| [inspect](string.html#inspectusedoublequotes-boolean) | 返回一个数组的字符串表示形式 | +| [hashCode](string.html#hashcode) | 获取字符串 hash code | +| [random](string.html#randomlength-number,-type?-randomtype-=-"numeric"-|-"letter"-|-"letter_numeric"-|-"chinese"-|-undefined) | 生成随机字符串 | + +--- + + +### **exists(str: string)** +* 类型:`Function` + +* 功能描述:判断字符串是否存在 + +* 参数:str - `string` 子字符串 + +* 返回值:`boolean` 子字符串存在返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **equals(str: string | undefined | null)** +* 类型:`Function` + +* 功能描述:判断字符串是否相等 + +* 参数:str - `string | undefined | null` 与此 String 进行比较的对象 + +* 返回值:`boolean` 字符串相等返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **equalsIgnoreCase(str: string | undefined | null)** +* 类型:`Function` + +* 功能描述:判断字符串是否相等,不考虑大小写 + +* 参数:str - `string | undefined | null` 与此 String 进行比较的对象 + +* 返回值:`boolean` 字符串相等返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isEmpty()** +* 类型:`Function` + +* 功能描述:判断是否为空字符串 + +* 参数:无 + +* 返回值:`boolean` 字符串为空,即长度为 0 返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isNotEmpty()** +* 类型:`Function` + +* 功能描述:判断是否不为空字符串 + +* 参数:无 + +* 返回值:`boolean` 字符串不为空,即长度大于 0 返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **isBlank()** +* 类型:`Function` + +* 功能描述:判断是否为空白字符串 + +* 参数:无 + +* 返回值:`boolean` 字符串全为空白字符串(即:空格、回车、Tag 制表位、非打印字符)返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **repeat(count: number)** +* 类型:`Function` + +* 功能描述:重复一个字符串 + +* 参数:count - `number` 重复次数 + +* 返回值:`string` 重复后的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **left(length: number)** +* 类型:`Function` + +* 功能描述:截取字符串左边边指定数目的字符串 + +* 参数:length - `number` 截取长度 + +* 返回值:`string` 子字符串,length 如果为负数,则返回空字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **right(length: number)** +* 类型:`Function` + +* 功能描述:截截取字符串右边指定数目的字符串 + +* 参数:length - `number` 截取长度 + +* 返回值:`string` 子字符串,length 如果为负数,则返回空字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **truncation(length: number, truncation?: string = "...")** +* 类型:`Function` + +* 功能描述:截取字符串,超出部分用 truncation 替代 + +* 参数:length - `number` 截取长度 + + truncation - `string` 替换字符串 + +* 返回值:`string` 截取后的字符串;实际截取长度:当 length 小于等于 truncation 的长度时为,length;当 length 大于 truncation 的长度时为,length - truncation.length + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **ltrim()** +* 类型:`Function` + +* 功能描述:删除字符串开头的空白字符(包括:空格、制表位、换行以及其它非打印字符) + +* 参数:无 + +* 返回值:`string` 删除了字符串最左边的空白字符的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **rtrim()** +* 类型:`Function` + +* 功能描述:删除字符串结尾的空白字符(包括:空格、制表位、换行以及其它非打印字符) + +* 参数:无 + +* 返回值:`string` 删除了字符串最右边的空白字符的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **startsWith(str: string)** +* 类型:`Function` + +* 功能描述:判断字符串是否以给定的字符串开头 + +* 参数:str - `string` 搜索的字符串 + +* 返回值:`boolean` 字符串是否以给定的字符串开头返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **endsWith(str: string)** +* 类型:`Function` + +* 功能描述:判断字符串是否以给定的字符串结尾 + +* 参数:str - `string` 搜索的字符串 + +* 返回值:`boolean` 字符串是否以给定的字符串结尾返回 true;否则,返回 false + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **lcfirst()** +* 类型:`Function` + +* 功能描述:首字母小写 + +* 参数:无 + +* 返回值:`string` 首字母小写后的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **ucfirst()** +* 类型:`Function` + +* 功能描述:首字母大写 + +* 参数:无 + +* 返回值:`string` 首字母大写后的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **escapeHTML()** +* 类型:`Function` + +* 功能描述:将 HTML 编码,参考:[https://www.w3school.com.cn/html/html_entities.asp](https://www.w3school.com.cn/html/html_entities.asp) + +* 参数:无 + +* 返回值:`string` 编码后的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **unescapeHTML()** +* 类型:`Function` + +* 功能描述:将 HTML 实体字符解码,参考:[https://www.w3school.com.cn/html/html_entities.asp](https://www.w3school.com.cn/html/html_entities.asp) + +* 参数:无 + +* 返回值:`string` 解码后的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **stripTag(tag: string)** +* 类型:`Function` + +* 功能描述:删除 HTML 标签 + +* 参数:tag - `string` 待删除标签 + +* 返回值:`string` 删除标签后的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **stripTags(tag: string)** +* 类型:`Function` + +* 功能描述:批量删除 HTML 标签 + +* 参数:tag - `string[] | string` 删除指定的标签 + +* 返回值:`string` 删除标签后的字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **stripScripts()** +* 类型:`Function` + +* 功能描述:删除 script 标签 + +* 参数:无 + +* 返回值:`string` 删除 script 标签后的字符串 + +示例: + +原生 JavaScript +```javascript +test'.stripScripts(); // test + +``` + +vue +```html + + + + + +test'.stripScripts() // +``` + + +### **toArray(delimiter: string)** +* 类型:`Function` + +* 功能描述:将字符串转换为数组 + +* 参数:delimiter - `string` 分隔字符 + +* 返回值:`string[]` 字符串数组 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **inspect(useDoubleQuotes: boolean)** +* 类型:`Function` + +* 功能描述:返回一个数组的字符串表示形式 + +* 参数:useDoubleQuotes - `boolean` 是否使用双引号引住 + +* 返回值:`string` 数组的字符串表示形式 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **hashCode()** +* 类型:`Function` + +* 功能描述:获取字符串 hash code + +* 参数:无 + +* 返回值:`number` 字符串的 hash code + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **random(length: number, type?: RandomType = "NUMERIC" | "LETTER" | "LETTER_NUMERIC" | "CHINESE" | undefined)** +* 类型:`Function` + +* 功能描述:生成随机字符串 + +* 参数:length - `number` 生成字符串的长度 + + type - `NUMERIC | LETTER | LETTER_NUMERIC | CHINESE | undefined` 生成类型,可选参数,当未指定时为 LETTER_NUMERIC + + NUMERIC - 数字随机字符串 + + LETTER - 英文随机字符串 + + LETTER_NUMERIC - 英文数字混合随机字符串 + + CHINESE - 中文随机字符串 + +* 返回值:`string` 随机字符串 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/try.md b/src/manual/3.0/try.md new file mode 100644 index 0000000..476f062 --- /dev/null +++ b/src/manual/3.0/try.md @@ -0,0 +1,59 @@ +# Try 参考手册 + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [these](try.html#theseargs-any[]) | 接收任意数目的函数作为参数,返回第一个执行成功的函数(未抛出异常的函数)的结果 | + + +--- + + +### **these(args: any[])** +* 类型:`Function` + +* 功能描述:接收任意数目的函数作为参数,返回第一个执行成功的函数(未抛出异常的函数)的结果 + +* 参数:args `any[]` 一个或多个 `function` 作为参数 + +* 返回值:`any` 任意函数参数执行结果 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` \ No newline at end of file diff --git a/src/manual/3.0/window.md b/src/manual/3.0/window.md new file mode 100644 index 0000000..ab0e1f9 --- /dev/null +++ b/src/manual/3.0/window.md @@ -0,0 +1,104 @@ +# Window 参考手册 + + +### 属性 + +| 属性 | 描述 | +| ---- | ---- | +| [browser](browser.html) | 浏览器信息对象 | +| [location](location.html) | Location 对象 | + + +### 方法 + +| 方法 | 描述 | +| ---- | ---- | +| [copy](window.html#copystr-string) | 将字符串复制到剪贴板 | +| [delay](window.html#copystr-string) | 将字符串复制到剪贴板 | + + +--- + + +### **copy(str: string)** +* 类型:`Function` + +* 功能描述:将字符串复制到剪贴板 + +* 参数:str - `string` 字符串 + +* 返回值:无 + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### **delay(func: Function, wait?: number, ...args: any)** +* 类型:`Function` + +* 功能描述:延时执行 + +* 参数:func - `Function` 方法 + wait - `number` 延时时长(单位:毫秒) + args - `any[]` 方法参数 + +* 返回值:any + +示例: + +原生 JavaScript +```javascript + +``` + +vue +```html + + + + + + +``` + + +### Browser + + +### Location \ No newline at end of file diff --git a/src/manual/SUMMARY.md b/src/manual/SUMMARY.md index 4818e2d..f9e4972 100644 --- a/src/manual/SUMMARY.md +++ b/src/manual/SUMMARY.md @@ -2,6 +2,22 @@ * [简介](index.md) * [参考指南](overview.md) + * [3.0.x](3.0/index.md) + * [Prototype](3.0/prototype.md) + * [Try](3.0/try.md) + * [Optional](3.0/optional.md) + * [Array](3.0/array.md) + * [Date](3.0/date.md) + * [Document](3.0/document.md) + * [Cookie](3.0/cookie.md) + * [Function](3.0/function.md) + * [Math](3.0/math.md) + * [Number](3.0/number.md) + * [Object](3.0/object.md) + * [String](3.0/string.md) + * [Window](3.0/window.md) + * [Browser](3.0/browser.md) + * [Location](3.0/location.md) * [2.2.x](2.2/index.md) * [Prototype](2.2/prototype.md) * [Try](2.2/try.md) diff --git a/src/manual/overview.md b/src/manual/overview.md index f154ef9..68b07ea 100644 --- a/src/manual/overview.md +++ b/src/manual/overview.md @@ -7,6 +7,7 @@ Buession Prototype [Array](https://www.w3school.com.cn/jsref/jsref_obj_array.asp | 版本 | 手册 | | ---- | ---- | +| 3.0.x | [API 手册](3.0/index.html) | | 2.2.x | [API 手册](2.2/index.html) | | 2.1.x | [API 手册](2.1/index.html) | | 2.0.x | [API 手册](2.0/index.html) | \ No newline at end of file