diff --git a/functions/CSVToJSON.html b/functions/CSVToJSON.html
new file mode 100644
index 0000000..761d4d9
--- /dev/null
+++ b/functions/CSVToJSON.html
@@ -0,0 +1,11 @@
+
Function CSVToJSON
Function JSONToCSV
Converts an array of objects to a comma-separated value (CSV) string containing only the specified columns.
+
diff --git a/functions/addEvent.html b/functions/addEvent.html
new file mode 100644
index 0000000..e9997aa
--- /dev/null
+++ b/functions/addEvent.html
@@ -0,0 +1,7 @@
+
Function addEvent
- addEvent(element: AnyObject, type: string, handler: AnyFunction): void
addEvent() event delegate, supports multiple delegates
+Parameters
- element: AnyObject
js dom object
+ - type: string
The event type. No need to add on
+ - handler: AnyFunction
callback method
+
Returns void
- element: AnyObject
Index
Properties
guid
+
Function all
Returns true if the provided predicate function returns true for all elements in a set, otherwise it returns false.
+- all<T = unknown>(arr: T[], fn: AnyFunction): boolean
Type Parameters
Parameters
- arr: T[]
the target array
+ - fn: AnyFunction
the judgment method
+
Returns boolean
-
+
- the result of the judgment +
- arr: T[]
Function any
Returns true if the provided predicate function returns true for at least one element of a set, otherwise it returns false.
+- any<T = unknown>(arr: T[], fn: AnyFunction): boolean
Type Parameters
Parameters
- arr: T[]
the target array
+ - fn: AnyFunction
the judgment method
+
Returns boolean
-
+
- the result of the judgment +
- arr: T[]
Function appVersion
- appVersion(appName: string): string | null
Get the APP version from navigator.userAgent, support 'x.x.x' & 'x.x.x-tagname.x'
+Parameters
- appName: string
app name
+
Returns string | null
string|null
+Example
+ +// navigator.userAgent => '5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 AppName/1.0.0-beta.8'
appVersion('Chrome') // 114.0.0.0
appVersion('Safari') // 537.36
appVersion('appname', false) // null
appVersion('appname') // 1.0.0-beta.8 +- appName: string
- appVersion(appName: string, ua: string): string | null
Get the APP version from navigator.userAgent, support 'x.x.x' & 'x.x.x-tagname.x'
+Parameters
- appName: string
app name
+ - ua: string
ua or any ua like string, allowed to be undefined, default is navigator.userAgent
+
Returns string | null
string|null
+Example
+ +// navigator.userAgent => '5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 AppName/1.0.0-beta.8'
appVersion('Chrome') // 114.0.0.0
appVersion('Safari') // 537.36
appVersion('appname', false) // null
appVersion('appname') // 1.0.0-beta.8 +- appName: string
- appVersion(appName: string, ua: boolean): string | null
Get the APP version from navigator.userAgent, support 'x.x.x' & 'x.x.x-tagname.x'
+Parameters
- appName: string
app name
+ - ua: boolean
ua or any ua like string, allowed to be undefined, default is navigator.userAgent
+
Returns string | null
string|null
+Example
+ +// navigator.userAgent => '5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 AppName/1.0.0-beta.8'
appVersion('Chrome') // 114.0.0.0
appVersion('Safari') // 537.36
appVersion('appname', false) // null
appVersion('appname') // 1.0.0-beta.8 +- appName: string
- appVersion(appName: string, ua: string, ignoreCase: boolean): string | null
Get the APP version from navigator.userAgent, support 'x.x.x' & 'x.x.x-tagname.x'
+Parameters
- appName: string
app name
+ - ua: string
ua or any ua like string, allowed to be undefined, default is navigator.userAgent
+ - ignoreCase: boolean
whether to ignore case
+
Returns string | null
string|null
+Example
+ +// navigator.userAgent => '5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 AppName/1.0.0-beta.8'
appVersion('Chrome') // 114.0.0.0
appVersion('Safari') // 537.36
appVersion('appname', false) // null
appVersion('appname') // 1.0.0-beta.8 +- appName: string
Function arrayBufferToBase64
diff --git a/functions/arrayToCSV.html b/functions/arrayToCSV.html
new file mode 100644
index 0000000..5b611eb
--- /dev/null
+++ b/functions/arrayToCSV.html
@@ -0,0 +1,8 @@
+
Function arrayToCSV
Converts a two-dimensional array to a comma-separated string of values (CSV).
+Function awaitTo
- awaitTo<T, E = Error>(promise: Promise<T>): Promise<[E, undefined] | [null, T]>
Async await wrapper for easy error handling
+Type Parameters
Parameters
- promise: Promise<T>
Promise
+
Returns Promise<[E, undefined] | [null, T]>
-
+
- result +
Example
+ +const bar = () => new Promise<boolean>((resolve, reject) => {})
const foo = () => new Promise<string>((resolve, reject) => {})
;(async () => {
const [err, data] = await awaitToDone(bar())
const [err1, data1] = await awaitToDone(bar(), foo())
const [err2, data2] = await awaitToDone([bar(), foo()])
})() +- promise: Promise<T>
- awaitTo<P extends [] | readonly unknown[], E = Error>(
promise: PromiseAll<P>,
): Promise<[E, undefined] | [null, P]> Async await wrapper for easy error handling
+Type Parameters
Parameters
- promise: PromiseAll<P>
Promise
+
Returns Promise<[E, undefined] | [null, P]>
-
+
- result +
Example
+ +const bar = () => new Promise<boolean>((resolve, reject) => {})
const foo = () => new Promise<string>((resolve, reject) => {})
;(async () => {
const [err, data] = await awaitToDone(bar())
const [err1, data1] = await awaitToDone(bar(), foo())
const [err2, data2] = await awaitToDone([bar(), foo()])
})() +- promise: PromiseAll<P>
- awaitTo<T, P extends [] | readonly unknown[], E = Error>(
promise: Promise<T>,
...promises: PromiseAll<P>,
): Promise<[E, undefined] | [null, [T, ...P]]> Async await wrapper for easy error handling
+Type Parameters
Returns Promise<[E, undefined] | [null, [T, ...P]]>
-
+
- result +
Example
+ +const bar = () => new Promise<boolean>((resolve, reject) => {})
const foo = () => new Promise<string>((resolve, reject) => {})
;(async () => {
const [err, data] = await awaitToDone(bar())
const [err1, data1] = await awaitToDone(bar(), foo())
const [err2, data2] = await awaitToDone([bar(), foo()])
})() +
diff --git a/functions/base64ToBlob.html b/functions/base64ToBlob.html
new file mode 100644
index 0000000..2f216cf
--- /dev/null
+++ b/functions/base64ToBlob.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/base64ToFile.html b/functions/base64ToFile.html
new file mode 100644
index 0000000..c5c33ee
--- /dev/null
+++ b/functions/base64ToFile.html
@@ -0,0 +1,8 @@
+
diff --git a/functions/blobToArrayBuffer.html b/functions/blobToArrayBuffer.html
new file mode 100644
index 0000000..7464f75
--- /dev/null
+++ b/functions/blobToArrayBuffer.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/blobToBase64.html b/functions/blobToBase64.html
new file mode 100644
index 0000000..3916686
--- /dev/null
+++ b/functions/blobToBase64.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/blobToUrl.html b/functions/blobToUrl.html
new file mode 100644
index 0000000..6bd6392
--- /dev/null
+++ b/functions/blobToUrl.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/browserVersion-1.html b/functions/browserVersion-1.html
new file mode 100644
index 0000000..636023b
--- /dev/null
+++ b/functions/browserVersion-1.html
@@ -0,0 +1,8 @@
+
Function browserVersion
- browserVersion(ua?: string): BrowserVersion | null
Get the browser name and version
+Parameters
Optionalua: stringua or any ua like string, allowed to be undefined, default is navigator.userAgent
+
Returns BrowserVersion | null
BrowserVersion|null
+
diff --git a/functions/cleanData.html b/functions/cleanData.html
new file mode 100644
index 0000000..2868189
--- /dev/null
+++ b/functions/cleanData.html
@@ -0,0 +1,8 @@
+
Function cleanData
diff --git a/functions/clearHtml.html b/functions/clearHtml.html
new file mode 100644
index 0000000..43e7631
--- /dev/null
+++ b/functions/clearHtml.html
@@ -0,0 +1,5 @@
+
diff --git a/functions/client.html b/functions/client.html
new file mode 100644
index 0000000..2469124
--- /dev/null
+++ b/functions/client.html
@@ -0,0 +1,9 @@
+
Function client
The client method returns a browser judgment result: { ANDROID: true, GECKO: true, GLSH_APP: false, IE: false, IOS: false, IPAD: false, IPHONE: false, MOBILE: true, MOBILEDEVICE. true, OPERA: false, QQ: false, QQBROWSER: false, TRIDENT: false, WEBKIT: true, WEIXIN: false }
- client(
name?: string,
userAgent?: string,
):
| boolean
| {
IE: boolean;
GECKO: boolean;
WEBKIT: boolean;
OPERA: boolean;
TRIDENT: boolean;
MOBILE: boolean;
IOS: boolean;
ANDROID: boolean;
IPHONE: boolean;
IPAD: boolean;
QQBROWSER: boolean;
WEIXIN: boolean;
QQ: null
| RegExpMatchArray;
} Parameters
- name: string = ''
optional, e.g. pass in MicroMessenger to return whether it is the built-in browser of Weixin
+ - userAgent: string = navigator.userAgent
optional, pass in a custom ua, default takes the browser's navigator.userAgent
+
Returns
| boolean
| {
IE: boolean;
GECKO: boolean;
WEBKIT: boolean;
OPERA: boolean;
TRIDENT: boolean;
MOBILE: boolean;
IOS: boolean;
ANDROID: boolean;
IPHONE: boolean;
IPAD: boolean;
QQBROWSER: boolean;
WEIXIN: boolean;
QQ: null
| RegExpMatchArray;
}-
+
- the common ua match table, if name is passed, then returns whether the terminal matches true/false +
- name: string = ''
Function clone
Function compareVersion
- compareVersion(input: string, compare: string): -1 | 0 | 1
Version number size comparison, tag version: rc > beta > alpha > other
+Parameters
- input: string
input version
+ - compare: string
compare version
+
Returns -1 | 0 | 1
1/0/-1
+Example
+ +compareVersion('1.11.0', '1.9.9')
// => 1: 1=Version 1.11.0 is newer than 1.9.9
compareVersion('1.11.0', '1.11.0')
// => 0: 0=Versions 1.11.0 and 1.11.0 are the same
compareVersion('1.11.0', '1.99.0')
// => -1: -1=Version 1.11.0 is older than 1.99.0
compareVersion('1.0.0.0.0.10', '1.0')
// => -1
// compare tag version: rc > beta > alpha > other
compareVersion('1.11.0', '1.11.0-beta.1')
// => -1
compareVersion('1.11.0-beta.1', '1.11.0')
// => -1
compareVersion('1.11.0-beta.10', '1.11.0-beta.10')
// => 0
compareVersion('1.11.0-alpha.10', '1.11.0-beta.1')
// => -1
compareVersion('1.11.0-alpha.10', '1.11.0-rc.1')
// => -1
compareVersion('1.11.0-tag.10', '1.11.0-alpha.1')
// => -1
compareVersion('1.11.0-tag.10', '1.11.0-tag.1')
// => 1
compareVersion('1.11.0-release.10', '1.11.0-tag.1')
// => 1 +- input: string
diff --git a/functions/contains.html b/functions/contains.html
new file mode 100644
index 0000000..df83b90
--- /dev/null
+++ b/functions/contains.html
@@ -0,0 +1,9 @@
+
diff --git a/functions/copy.html b/functions/copy.html
new file mode 100644
index 0000000..350f80b
--- /dev/null
+++ b/functions/copy.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/cutCHSString.html b/functions/cutCHSString.html
new file mode 100644
index 0000000..b862736
--- /dev/null
+++ b/functions/cutCHSString.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/dash2Camel.html b/functions/dash2Camel.html
new file mode 100644
index 0000000..851240e
--- /dev/null
+++ b/functions/dash2Camel.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/decodeBase64.html b/functions/decodeBase64.html
new file mode 100644
index 0000000..b539d00
--- /dev/null
+++ b/functions/decodeBase64.html
@@ -0,0 +1,5 @@
+
diff --git a/functions/decodeUtf8.html b/functions/decodeUtf8.html
new file mode 100644
index 0000000..b30841c
--- /dev/null
+++ b/functions/decodeUtf8.html
@@ -0,0 +1,4 @@
+
diff --git a/functions/delCache.html b/functions/delCache.html
new file mode 100644
index 0000000..f2afde0
--- /dev/null
+++ b/functions/delCache.html
@@ -0,0 +1,4 @@
+
diff --git a/functions/delCookie.html b/functions/delCookie.html
new file mode 100644
index 0000000..7d4e1ae
--- /dev/null
+++ b/functions/delCookie.html
@@ -0,0 +1,4 @@
+
diff --git a/functions/delSession.html b/functions/delSession.html
new file mode 100644
index 0000000..bdb1bc8
--- /dev/null
+++ b/functions/delSession.html
@@ -0,0 +1,4 @@
+
diff --git a/functions/delay.html b/functions/delay.html
new file mode 100644
index 0000000..a2916dd
--- /dev/null
+++ b/functions/delay.html
@@ -0,0 +1,4 @@
+
Function delay
- delay(): {
map: any;
register(id: string, fn: AnyFunction, time: number, boo: boolean): void;
destroy(id: string): void;
} debounce & throttle
+Returns {
map: any;
register(id: string, fn: AnyFunction, time: number, boo: boolean): void;
destroy(id: string): void;
}class
+
Function download
- download(url: string, filename: string, type?: string): void
Several ways of file downloading:
+-
+
- For file formats that some browsers do not recognize. Enter the file URL in the address bar, window.location.href = URL, window.open(URL); +
- using a tag download attribute (or js create a tag); +
- browser-recognizable pdf, txt files, back-end compatible with handling attachment; +
- add token in the header for authenticated download, use XmlHttpRequest to want to backend to launch the request +
Parameters
- url: string
link
+ - filename: string
filename
+ Optionaltype: stringdownload type 'href','open','download','request'
+
Returns void
diff --git a/functions/encodeUtf8.html b/functions/encodeUtf8.html
new file mode 100644
index 0000000..3565539
--- /dev/null
+++ b/functions/encodeUtf8.html
@@ -0,0 +1,6 @@
+
diff --git a/functions/escape.html b/functions/escape.html
new file mode 100644
index 0000000..ea44374
--- /dev/null
+++ b/functions/escape.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/extend.html b/functions/extend.html
new file mode 100644
index 0000000..ab86ab6
--- /dev/null
+++ b/functions/extend.html
@@ -0,0 +1,17 @@
+
Function extend
- extend(
target: ExtendObjectData,
...args: ArrayOneMore<ExtendObjectData>,
): ExtendObjectData deep copy & merge objects
+Parameters
- target: ExtendObjectData
boolean | ExtendData
+ - ...args: ArrayOneMore<ExtendObjectData>
ArrayOneMore
+
Returns ExtendObjectData
- target: ExtendObjectData
- extend(
target: boolean,
...args: ArrayOneMore<ExtendObjectData>,
): ExtendObjectData deep copy & merge objects
+Parameters
- target: boolean
boolean | ExtendData
+ - ...args: ArrayOneMore<ExtendObjectData>
ArrayOneMore
+
Returns ExtendObjectData
- target: boolean
- extend(
target: ExtendArrayData,
...args: ArrayOneMore<ExtendArrayData>,
): ExtendArrayData deep copy & merge objects
+Parameters
- target: ExtendArrayData
boolean | ExtendData
+ - ...args: ArrayOneMore<ExtendArrayData>
ArrayOneMore
+
Returns ExtendArrayData
- target: ExtendArrayData
- extend(target: boolean, ...args: ArrayOneMore<ExtendArrayData>): ExtendArrayData
deep copy & merge objects
+Parameters
- target: boolean
boolean | ExtendData
+ - ...args: ArrayOneMore<ExtendArrayData>
ArrayOneMore
+
Returns ExtendArrayData
- target: boolean
diff --git a/functions/fillIPv6.html b/functions/fillIPv6.html
new file mode 100644
index 0000000..65835be
--- /dev/null
+++ b/functions/fillIPv6.html
@@ -0,0 +1,9 @@
+
diff --git a/functions/fingerprint.html b/functions/fingerprint.html
new file mode 100644
index 0000000..0cc95a6
--- /dev/null
+++ b/functions/fingerprint.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/fixNumber.html b/functions/fixNumber.html
new file mode 100644
index 0000000..602e89c
--- /dev/null
+++ b/functions/fixNumber.html
@@ -0,0 +1,11 @@
+
Function fixNumber
Function getAppVersion
- getAppVersion(
appName: string,
withApp?: boolean,
userAgent?: string,
): string | boolean | null Get the APP version number
+Parameters
- appName: string
app name
+ OptionalwithApp: booleanwhether to bring the name
+OptionaluserAgent: stringua, allowed to be undefined, default is navigator.userAgent
+
Returns string | boolean | null
null/true/false
+- appName: string
diff --git a/functions/getCache.html b/functions/getCache.html
new file mode 100644
index 0000000..02602e7
--- /dev/null
+++ b/functions/getCache.html
@@ -0,0 +1,10 @@
+
Function getCache
diff --git a/functions/getCookies.html b/functions/getCookies.html
new file mode 100644
index 0000000..9a9bb88
--- /dev/null
+++ b/functions/getCookies.html
@@ -0,0 +1,9 @@
+
diff --git a/functions/getDirParam.html b/functions/getDirParam.html
new file mode 100644
index 0000000..e01149a
--- /dev/null
+++ b/functions/getDirParam.html
@@ -0,0 +1,8 @@
+
Function getDirParam
- getDirParam(url: string): DirParamType
Get directory form URL parameters
+Parameters
- url: string
pass in the url address
+
Returns DirParamType
-
+
- parameter object +
- url: string
Function getFileType
- getFileType(
url: string,
): {
suffix: string;
type:
| "audio"
| "video"
| "image"
| "other"
| "word"
| "txt"
| "excel"
| "pdf"
| "ppt"
| "zip";
} Determine file type based on link suffix
+Parameters
- url: string
file url
+
Returns {
suffix: string;
type:
| "audio"
| "video"
| "image"
| "other"
| "word"
| "txt"
| "excel"
| "pdf"
| "ppt"
| "zip";
}result
+- url: string
diff --git a/functions/getOsVersion.html b/functions/getOsVersion.html
new file mode 100644
index 0000000..2455776
--- /dev/null
+++ b/functions/getOsVersion.html
@@ -0,0 +1,13 @@
+
Function getOsVersion
- getOsVersion(
osName: string,
withOS?: boolean,
userAgent?: string,
): string | boolean | null Get the phone system version
+Parameters
- osName: string
system type string Android, iPod, iWatch or iPhone
+ OptionalwithOS: booleanwhether to bring the name
+OptionaluserAgent: stringua, allowed to be undefined, default takes navigator.userAgent
+
Returns string | boolean | null
-
+
- null/true/false +
- osName: string
Function getProperty
- getProperty<T extends Record<string, any>>(
target: T,
prop: string | () => string,
defaultValue?: any,
): any Get array, object property values based on path string
+Type Parameters
Parameters
- target: T
target array, object
+ - prop: string | () => string
query target, can pass function
+ OptionaldefaultValue: anydefault value
+
Returns any
result
+- target: T
- getProperty<T extends any[]>(
target: T,
prop: string | () => string,
defaultValue?: any,
): any Get array, object property values based on path string
+Type Parameters
Parameters
- target: T
target array, object
+ - prop: string | () => string
query target, can pass function
+ OptionaldefaultValue: anydefault value
+
Returns any
result
+- target: T
Function getQueryParam
- getQueryParam(key: string): string | undefined
Get a single query parameter (behind "#")
+Parameters
- key: string
key name
+
Returns string | undefined
-
+
- result +
- key: string
- getQueryParam(key: string, url: string): string | undefined
Get a single query parameter (behind "#")
+Parameters
- key: string
key name
+ - url: string
pass in the url string
+
Returns string | undefined
-
+
- result +
- key: string
Function getQueryParams
- getQueryParams(url: string): Record<string, string>
Get all URL parameters (behind "#")
+Parameters
- url: string
pass in the url string
+
Returns Record<string, string>
-
+
- result +
- url: string
- getQueryParams(url: boolean): Record<string, unknown>
Get all URL parameters (behind "#")
+Parameters
- url: boolean
pass in the url string
+
Returns Record<string, unknown>
-
+
- result +
- url: boolean
- getQueryParams(url: string, covert: boolean): Record<string, unknown>
Get all URL parameters (behind "#")
+Parameters
- url: string
pass in the url string
+ - covert: boolean
Converts a specific string to a corresponding value (Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)
+
Returns Record<string, unknown>
-
+
- result +
- url: string
diff --git a/functions/getSession.html b/functions/getSession.html
new file mode 100644
index 0000000..49e2e20
--- /dev/null
+++ b/functions/getSession.html
@@ -0,0 +1,10 @@
+
Function getSession
Function getType
- getType<T = any>(
target: T,
):
| "string"
| "number"
| "bigint"
| "boolean"
| "symbol"
| "undefined"
| "object"
| "function"
| "window"
| "error"
| "promise"
| "math"
| "document"
| "navigator"
| "global"
| "array"
| "null"
| "date"
| "regexp" Get the target type
+Type Parameters
Parameters
- target: T
target
+
Returns
| "string"
| "number"
| "bigint"
| "boolean"
| "symbol"
| "undefined"
| "object"
| "function"
| "window"
| "error"
| "promise"
| "math"
| "document"
| "navigator"
| "global"
| "array"
| "null"
| "date"
| "regexp"type
+- target: T
Function getUrlParam
- getUrlParam(key: string): string | undefined
Get a single URL parameter (from the "location.search", before "#")
+Parameters
- key: string
key name
+
Returns string | undefined
-
+
- result +
- key: string
- getUrlParam(key: string, url: string): string | undefined
Get a single URL parameter (from the "location.search", before "#")
+Parameters
- key: string
key name
+ - url: string
pass in the url string
+
Returns string | undefined
-
+
- result +
- key: string
Function getUrlParams
- getUrlParams(url: string): Record<string, string>
Get all URL parameters (from the "location.search", before "#")
+Parameters
- url: string
pass in the url string
+
Returns Record<string, string>
-
+
- result +
- url: string
- getUrlParams(url: boolean): Record<string, unknown>
Get all URL parameters (from the "location.search", before "#")
+Parameters
- url: boolean
pass in the url string
+
Returns Record<string, unknown>
-
+
- result +
- url: boolean
- getUrlParams(url: string, covert: boolean): Record<string, unknown>
Get all URL parameters (from the "location.search", before "#")
+Parameters
- url: string
pass in the url string
+ - covert: boolean
Converts a specific string to a corresponding value (Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)
+
Returns Record<string, unknown>
-
+
- result +
- url: string
diff --git a/functions/isArray.html b/functions/isArray.html
new file mode 100644
index 0000000..afdabaa
--- /dev/null
+++ b/functions/isArray.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/isDarkMode.html b/functions/isDarkMode.html
new file mode 100644
index 0000000..48a5d42
--- /dev/null
+++ b/functions/isDarkMode.html
@@ -0,0 +1,9 @@
+
diff --git a/functions/isDate.html b/functions/isDate.html
new file mode 100644
index 0000000..eb84e03
--- /dev/null
+++ b/functions/isDate.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/isDigitals.html b/functions/isDigitals.html
new file mode 100644
index 0000000..bdf37bd
--- /dev/null
+++ b/functions/isDigitals.html
@@ -0,0 +1,8 @@
+
diff --git a/functions/isEqual.html b/functions/isEqual.html
new file mode 100644
index 0000000..be6d9ea
--- /dev/null
+++ b/functions/isEqual.html
@@ -0,0 +1,11 @@
+
Function isEqual
diff --git a/functions/isExitsVariable.html b/functions/isExitsVariable.html
new file mode 100644
index 0000000..4c4b49a
--- /dev/null
+++ b/functions/isExitsVariable.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/isIterable.html b/functions/isIterable.html
new file mode 100644
index 0000000..a4bff0d
--- /dev/null
+++ b/functions/isIterable.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/isNumberBrowser.html b/functions/isNumberBrowser.html
new file mode 100644
index 0000000..2f42cae
--- /dev/null
+++ b/functions/isNumberBrowser.html
@@ -0,0 +1,10 @@
+
Function isNumberBrowser
diff --git a/functions/isPlainObject.html b/functions/isPlainObject.html
new file mode 100644
index 0000000..cfdab49
--- /dev/null
+++ b/functions/isPlainObject.html
@@ -0,0 +1,10 @@
+
Function isPlainObject
- isPlainObject(target: unknown): target is PlainObject
Determine if target is an plain object
+Parameters
- target: unknown
any target
+
Returns target is PlainObject
-
+
- target is plain Object +
- target: unknown
diff --git a/functions/isWindow.html b/functions/isWindow.html
new file mode 100644
index 0000000..0aff998
--- /dev/null
+++ b/functions/isWindow.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/loadSource.html b/functions/loadSource.html
new file mode 100644
index 0000000..27db457
--- /dev/null
+++ b/functions/loadSource.html
@@ -0,0 +1,7 @@
+
Function loadSource
- loadSource(
url: string,
option: string | SourceOptions,
): Promise<boolean | string> Dynamic loading of resources, support js, images, css links, css style strings
+Parameters
- url: string
link to the resource, type must be passed when passing in styleString
+ - option: string | SourceOptions
parameters: attrs, props, force
+
Returns Promise<boolean | string>
-
+
- true|false|imgUrl +
- url: string
Function mapTemplate
- mapTemplate(
tmp: string,
data: Record<string, unknown> | (value: string) => unknown,
): string Replacing specific data in a template string, support
+${xxxx}{{xxxx}}and{xxxx}Parameters
- tmp: string
Template string
+ - data: Record<string, unknown> | (value: string) => unknown
Template data of map function
+
Returns string
-
+
- result +
Example
+ +const tmp = "My name is ${name}, I'm ${age} years old."
mapTemplate(tmp, {
name: 'saqqdy',
age: 18
})
// My name is saqqdy, I'm 18 years old.
mapTemplate(tmp, key => ({ name: 'saqqdy', age: 28 }[key]))
// My name is saqqdy, I'm 28 years old.
const tmp = "My name is {{name}}, I'm {{age}} years old."
mapTemplate(tmp, {
name: 'saqqdy',
age: 18
})
// My name is saqqdy, I'm 18 years old. +- tmp: string
Function minus
diff --git a/functions/mountImg.html b/functions/mountImg.html
new file mode 100644
index 0000000..95203f9
--- /dev/null
+++ b/functions/mountImg.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/mountJs.html b/functions/mountJs.html
new file mode 100644
index 0000000..f8d7b21
--- /dev/null
+++ b/functions/mountJs.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/mountStyle.html b/functions/mountStyle.html
new file mode 100644
index 0000000..7bc2763
--- /dev/null
+++ b/functions/mountStyle.html
@@ -0,0 +1,6 @@
+
diff --git a/functions/nextIndex.html b/functions/nextIndex.html
new file mode 100644
index 0000000..a047728
--- /dev/null
+++ b/functions/nextIndex.html
@@ -0,0 +1,11 @@
+
Function nextIndex
Function nextVersion
- nextVersion(
version: string,
type?:
| "major"
| "minor"
| "patch"
| "premajor"
| "preminor"
| "prepatch"
| "prerelease",
preid?: string,
): string return the next version, Only version types with no more than 3 digits are supported. (Follow the npm version rules)
+Parameters
- version: string
version(like: 1.0.0)
+ Optionaltype:
| "major"
| "minor"
| "patch"
| "premajor"
| "preminor"
| "prepatch"
| "prerelease"optional, version type
+- preid: string = ''
optional, prerelease id
+
Returns string
-
+
- new version +
- version: string
diff --git a/functions/osVersion-1.html b/functions/osVersion-1.html
new file mode 100644
index 0000000..3b4bff8
--- /dev/null
+++ b/functions/osVersion-1.html
@@ -0,0 +1,8 @@
+
Function osVersion
- osVersion(ua?: string): OsVersion | null
Get the system name and version
+Parameters
Optionalua: stringua or any ua like string, allowed to be undefined, default is navigator.userAgent
+
Returns OsVersion | null
OsVersion|null
+Example
+ +// ipad => 'Mozilla/5.0 (iPad; CPU OS 13_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/87.0.4280.77 Mobile/15E148 Safari/604.1'
osVersion() // \{ name: 'iOS', version: '13.3' \}
// iphone => 'Mozilla/5.0 (iPhone; CPU iPhone OS 13_2_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Mobile/15E148 Safari/604.1'
osVersion() // \{ name: 'iOS', version: '13.2.3' \}
// mac os => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36'
osVersion() // \{ name: 'MacOS', version: '10.15.7' \}
// windows => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36'
osVersion() // \{ name: 'Windows', version: '10.0' \}
// windows xp => 'Mozilla/5.0 (Windows NT 5.2; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36'
osVersion() // \{ name: 'Windows', version: 'XP' \}
// windows phone => 'Mozilla/5.0 (Windows Phone OS 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.82 Safari/537.36'
osVersion() // \{ name: 'WindowsPhone', version: '10.0' \}
+
Function parseUrlParam
- parseUrlParam(url: string, covert?: boolean): Record<string, unknown>
parse url params
+Parameters
- url: string
url string (like: ?key1=value1&key2=value2)
+ - covert: boolean = false
Converts a specific string to a corresponding value (Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)
+
Returns Record<string, unknown>
object
+Example
+ +parseUrlParam('?key1=100&key2=true&key3=null&key4=undefined&key5=NaN&key6=10.888&key7=Infinity&key8=test')
// \{"key1":"100","key2":"true","key3":"null","key4":"undefined","key5":"NaN","key6":"10.888","key7":"Infinity","key8":"test"\}
parseUrlParam('?key1=100&key2=true&key3=null&key4=undefined&key5=NaN&key6=10.888&key7=Infinity&key8=test', true)
// \{"key1":100,"key2":true,"key3":null,"key5":NaN,"key6":10.888,"key7":Infinity,"key8":"test"\} +- url: string
Function preloader
Function promiseFactory
- promiseFactory<T extends object>(
original: T,
resolver: () => Promise<any>,
): T & PromiseLike<T> Convert an object to a promise like api
+Type Parameters
Parameters
- original: T
original object
+ - resolver: () => Promise<any>
resolver function
+
Returns T & PromiseLike<T>
-
+
- result +
Example
+ +import { promiseFactory, waiting } from 'js-cool'
function promise() {
const stats = {
value: 100
}
const resolver = () =>
new Promise(resolve =>
waiting(2000).then(() => {
stats.value = 200
resolve(stats)
})
)
return promiseFactory(stats, resolver)
}
const res = promise() // res => 100
const res = await promise() // res => 200 +- original: T
Function punctualTimer
- punctualTimer<TArgs extends any[]>(
handler: (args: void) => void,
delay: number,
args?: TArgs,
): PunctualTimerReturns punctual setInterval
+Type Parameters
Parameters
- handler: (args: void) => void
A function to be executed after the timer expires.
+ - delay: number
The time, in milliseconds that the timer should wait before the specified function or code is executed. If this parameter is omitted, a value of 0 is used, meaning execute "immediately", or more accurately, the next event cycle.
+ Optionalargs: TArgsAdditional arguments which are passed through to the function specified by handler.
+
Returns PunctualTimerReturns
- handler: (args: void) => void
- punctualTimer<TArgs extends any[]>(
handler: (...args: TArgs) => void,
delay: number,
args?: TArgs,
): PunctualTimerReturns punctual setInterval
+Type Parameters
Parameters
- handler: (...args: TArgs) => void
A function to be executed after the timer expires.
+ - delay: number
The time, in milliseconds that the timer should wait before the specified function or code is executed. If this parameter is omitted, a value of 0 is used, meaning execute "immediately", or more accurately, the next event cycle.
+ Optionalargs: TArgsAdditional arguments which are passed through to the function specified by handler.
+
Returns PunctualTimerReturns
- handler: (...args: TArgs) => void
Function randomColor
- randomColor(
min?: number | [number, number, number],
max?: number | [number, number, number],
): string Generate random hexadecimal colors
+Parameters
Optionalmin: number | [number, number, number]the minimum value of the random numbers, eg: [10, 10, 10]
+Optionalmax: number | [number, number, number]the maximum value of the random number, eg: [255, 255, 255]
+
Returns string
-
+
- result +
Function randomNumber
Function randomNumbers
- randomNumbers(n?: number, sum?: number, noZero?: boolean): number[]
Generate n random integers that sum to a fixed sum
+Parameters
Optionaln: numberNumber of generated integers, default: 1
+Optionalsum: numberSum of generated integers, default: 100
+OptionalnoZero: boolean
Returns number[]
-
+
- numbers +
Function randomString
- randomString(len?: number, options?: boolean | RandomStringOptions): string
Get a random string
+Parameters
Optionallen: numberthe length of the random string that needs to be obtained
+Optionaloptions: boolean | RandomStringOptionsoptional, randomString options
+
Returns string
-
+
- random string +
Example
+ +// 1. No parameters are passed, a 32-bit (possibly) string containing upper and lower case letters and numbers is generated by default
randomString()
// PVSjz902EqYbmxaLtvDnggtnlvt5uFTZ
// 2. Generate a 16-bit random string
randomString(16)
// coTgZy0mqqMJ1sMM
// 3. Same effect as #2 above
randomString({
length: 16
})
// ngCI5aPqJm84t90d
// 4. Generate containing special characters (old way of passing values, not recommended)
randomString(true)
// 0Uby@op3B-sK5]dHl4S|15As.OlHiNXd
// 5. Same effect as #4 above (recommended)
randomString({
charTypes: ['uppercase', 'lowercase', 'number', 'special']
})
// m,2^vpkrE,F,DbcSFk0=vr&@DJ27j9XK
// 6. Same effect as #4 above, Limit string length to 16 bits
randomString(16, true)
// dXz[J_sYM^3d8fnA
// 7. Generate a 16-bit random number
randomString({
length: 16,
charTypes: 'number'
})
// 7450026301030286
// 8. Elimination of confusing characters: oOLl,9gq,Vv,Uu,I1
randomString({
length: 16,
noConfuse: true
})
// 8DEGna8ppC4mqyew
// 9. The generated random string must contain at least 1 character of each type of character specified, e.g. to generate a 16-bit password that must contain upper and lower case letters, numbers, and special characters.
randomString({
length: 16,
strict: true
})
// PFYAPD5KFqOHIADL +- randomString(
len?: boolean | RandomStringOptions,
options?: boolean | RandomStringOptions,
): string Get a random string
+Parameters
Optionallen: boolean | RandomStringOptionsthe length of the random string that needs to be obtained
+Optionaloptions: boolean | RandomStringOptionsoptional, randomString options
+
Returns string
-
+
- random string +
Example
+ +// 1. No parameters are passed, a 32-bit (possibly) string containing upper and lower case letters and numbers is generated by default
randomString()
// PVSjz902EqYbmxaLtvDnggtnlvt5uFTZ
// 2. Generate a 16-bit random string
randomString(16)
// coTgZy0mqqMJ1sMM
// 3. Same effect as #2 above
randomString({
length: 16
})
// ngCI5aPqJm84t90d
// 4. Generate containing special characters (old way of passing values, not recommended)
randomString(true)
// 0Uby@op3B-sK5]dHl4S|15As.OlHiNXd
// 5. Same effect as #4 above (recommended)
randomString({
charTypes: ['uppercase', 'lowercase', 'number', 'special']
})
// m,2^vpkrE,F,DbcSFk0=vr&@DJ27j9XK
// 6. Same effect as #4 above, Limit string length to 16 bits
randomString(16, true)
// dXz[J_sYM^3d8fnA
// 7. Generate a 16-bit random number
randomString({
length: 16,
charTypes: 'number'
})
// 7450026301030286
// 8. Elimination of confusing characters: oOLl,9gq,Vv,Uu,I1
randomString({
length: 16,
noConfuse: true
})
// 8DEGna8ppC4mqyew
// 9. The generated random string must contain at least 1 character of each type of character specified, e.g. to generate a 16-bit password that must contain upper and lower case letters, numbers, and special characters.
randomString({
length: 16,
strict: true
})
// PFYAPD5KFqOHIADL +
Function removeEvent
- removeEvent(element: AnyObject, type: string, handler: AnyFunction): void
removeEvent removes the event delegate created by addEvent
+Parameters
- element: AnyObject
js dom object
+ - type: string
The type of the event. No need to add on
+ - handler: AnyFunction
Callback method.
+
Returns void
- element: AnyObject
Function safeParse
Function safeStringify
- safeStringify(data: any, covert?: boolean): string
Secure stringify of JSON Object
+Parameters
- data: any
JSON Object
+ - covert: boolean = true
Whether to convert data, default: true
+
Returns string
-
+
- JSON String +
Example
+ +safeStringify(100)
// "100"
safeStringify(undefined)
// "undefined"
safeStringify(NaN)
// "NaN"
safeStringify(Infinity)
// "Infinity"
safeStringify({ a: undefined, b: NaN, c: Infinity, d: BigInt(Number.MAX_SAFE_INTEGER) + 2n })
// {"a":"undefined","b":"NaN","c":"Infinity","d":"9007199254740993"} +- data: any
Function searchObject
- searchObject(
tree: object | any[],
expression: any,
keySet: SearchKeySet,
number?: number,
): any[] tree object depth lookup
+Parameters
- tree: object | any[]
tree object
+ - expression: any
required Query method
+ - keySet: SearchKeySet
optional Default subclass name, query name
+ - number: number = 0
optional Number of lookups, if not passed, query all
+
Returns any[]
-
+
- the queried array +
- tree: object | any[]
Function setCache
- setCache<T = unknown>(name: string, value: T, seconds?: string | number): void
Get the cache, if the deposited is Object, the retrieved is also Object, no need to convert again
+Type Parameters
Parameters
- name: string
cache name
+ - value: T
cache data, can be passed directly into Object
+ Optionalseconds: string | numbercache time (seconds)
+
Returns void
- name: string
Function setCookie
- setCookie<T extends string | number | boolean>(
name: string,
value: T,
seconds: string | number,
path?: string,
samesite?: boolean,
): void setCookie method for writing cookies
+Type Parameters
Parameters
- name: string
cookie name
+ - value: T
Set the value to be stored, either as an object or as a string
+ - seconds: string | number
cookie validity default 1 day
+ - path: string = '/'
path, default '/'
+ - samesite: boolean = true
SameSite, default true
+
Returns void
- name: string
Function setProperty
Function setSession
Function shuffle
- shuffle(value: string, size?: number): string
shuffling algorithm, Reordering arrays or strings
+Parameters
- value: string
arrays or strings
+ Optionalsize: numbernew array or string length
+
Returns string
-
+
- result +
- value: string
- shuffle<T extends unknown[] = unknown[]>(value: T, size?: number): T
shuffling algorithm, Reordering arrays or strings
+Type Parameters
Parameters
- value: T
arrays or strings
+ Optionalsize: numbernew array or string length
+
Returns T
-
+
- result +
- value: T
Function sortPinyin
- sortPinyin<T = string, P = string>(
a: T,
b: P,
options?: CollatorOptions,
): number Sort Chinese by Chinese phonetic alphabet
+Type Parameters
Parameters
Returns number
-
+
- number +
Example
+ +const items = ['啊我', '波拉', 'abc', 0, 3, '10', ',11', 13, null, '阿吧', 'ABB', 'BDD', 'ACD', 'ä']
items.sort(sortPinyin)
// [ ",11", 0, "10", 13, 3, "ä", "ABB", "abc", "ACD", "BDD", null, "阿吧", "啊我", "波拉" ]
items.sort((a, b) => sortPinyin(a, b, { ignorePunctuation: true, numeric:true }))
// [ 0, 3, "10", ",11", 13, "ä", "ABB", "abc", "ACD", "BDD", null, "阿吧", "啊我", "波拉" ] +
Function sorter
- sorter(
locales?: string | string[],
options?: CollatorOptions,
): <T = string, P = string>(a: T, b: P) => number Sorter factory function
+Parameters
Optionallocales: string | string[]A string with a BCP 47 language tag, or an array of such strings.
+Optionaloptions: CollatorOptionsAn object adjusting the output format.
+
Returns <T = string, P = string>(a: T, b: P) => number
-
+
- compare function +
Function spliceUrlParam
- spliceUrlParam<T extends Record<string, unknown>>(
params: T,
covert?: boolean | SpliceUrlParamOptions,
): string splice url params
+Type Parameters
Parameters
- params: T
json object
+ - covert: boolean | SpliceUrlParamOptions = false
Convert a null value type (null/undefined/) to an empty string, default: false
+
Returns string
-
+
- result +
Example
+ +spliceUrlParam(\{"key1":"100","key2":true,"key3":null,"key4":undefined,"key5":"测试"\})
// ?key1=100&key2=true&key3=null&key4=undefined&key5=测试
spliceUrlParam(\{"key1":"100","key2":true,"key3":null,"key4":undefined,"key5":"测试"\}, \{ encode: true \})
// ?key1=100&key2=true&key3=null&key4=undefined&key5=%E6%B5%8B%E8%AF%95
spliceUrlParam(\{"key1":"100","key2":true,"key3":null,"key4":undefined\}, true)
// ?key1=100&key2=true&key3=&key4=
spliceUrlParam(\{"key1":"100","key2":true,"key3":null,"key4":undefined\}, \{ covert: true, withQuestionsMark: false \})
// key1=100&key2=true&key3=&key4= +- params: T
diff --git a/functions/stopDefault.html b/functions/stopDefault.html
new file mode 100644
index 0000000..04a2db5
--- /dev/null
+++ b/functions/stopDefault.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/svgToBlob.html b/functions/svgToBlob.html
new file mode 100644
index 0000000..2569367
--- /dev/null
+++ b/functions/svgToBlob.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/toThousands.html b/functions/toThousands.html
new file mode 100644
index 0000000..e45bb2e
--- /dev/null
+++ b/functions/toThousands.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/trim.html b/functions/trim.html
new file mode 100644
index 0000000..24eeb11
--- /dev/null
+++ b/functions/trim.html
@@ -0,0 +1,8 @@
+
diff --git a/functions/unescape.html b/functions/unescape.html
new file mode 100644
index 0000000..be9d6c2
--- /dev/null
+++ b/functions/unescape.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/union.html b/functions/union.html
new file mode 100644
index 0000000..f79dc16
--- /dev/null
+++ b/functions/union.html
@@ -0,0 +1,10 @@
+
Function union
diff --git a/functions/upperFirst.html b/functions/upperFirst.html
new file mode 100644
index 0000000..9983654
--- /dev/null
+++ b/functions/upperFirst.html
@@ -0,0 +1,10 @@
+
diff --git a/functions/urlToBlob.html b/functions/urlToBlob.html
new file mode 100644
index 0000000..d111187
--- /dev/null
+++ b/functions/urlToBlob.html
@@ -0,0 +1,7 @@
+
diff --git a/functions/uuid.html b/functions/uuid.html
new file mode 100644
index 0000000..f6bc791
--- /dev/null
+++ b/functions/uuid.html
@@ -0,0 +1,9 @@
+
diff --git a/functions/waiting.html b/functions/waiting.html
new file mode 100644
index 0000000..21896d1
--- /dev/null
+++ b/functions/waiting.html
@@ -0,0 +1,5 @@
+
diff --git a/functions/windowSize.html b/functions/windowSize.html
new file mode 100644
index 0000000..06adac2
--- /dev/null
+++ b/functions/windowSize.html
@@ -0,0 +1,9 @@
+
Function windowSize
- windowSize(): WindowSizeObj
windowSize to get the window size
+Returns WindowSizeObj
-
+
- the width and height +
JS-COOL DOCS - v5.23.1
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
- Installation +
- Usage + + +
- API Reference
+
-
+
- Global Parameters + + +
- Extras for String & Array & Object & Function
+
-
+
- clearAttr - Remove all attributes of HTML tags +
- clearHtml - Removing HTML tags +
- escape - Escaping HTML Special Characters +
- unescape - Restore HTML Special Characters +
- getNumber - Get the number in the string +
- camel2Dash - Converts humped strings to -spaced and all lowercase Dash pattern +
- dash2Camel - Converts -spaced and all lowercase Dash patterns to humped strings +
- randomColor - Generate random hexadecimal colors +
- randomNumber - Get a random number +
- randomNumbers - Generate n random integers that sum to a fixed sum +
- randomString - Get a random string +
- shuffle - shuffling algorithm, Reordering arrays or strings +
- fingerprint - Generating Browser Fingerprints +
- getCHSLength - Get the length of the string, Chinese counts as 2 characters +
- cutCHSString - Intercept string, Chinese counts as 2 bytes +
- upperFirst - First letter capitalized +
+ - Determine
+
-
+
- isDigitals - Determine if a string is a number +
- isExitsFunction - Determine if a function is defined +
- isExitsVariable - Determine if a variable is defined +
- isEqual - Determine if 2 objects are equal +
- isWindow - Determine if window object +
- isPlainObject - Determine if target is an plain object +
- isDarkMode - Determine if dark color mode +
- isObject - Determine if target is an object +
- isDate - Determine if target is Date +
- isRegExp - Determine if target is RegExp +
- isArray - Determine if it is an array +
- isIterable - Determine if it is iterable +
- inBrowser - Determine if it is running on the browser side +
- inNodeJs - Determine if it is running on node.js +
- isNumberBrowser - Detect if the client is a 360 browser +
- windowSize - Get the window size +
- getAppVersion - Get the APP version number +
- appVersion - Get the app version number +
- getOsVersion - Get the phone system version +
- osVersion - get the system version +
- browserVersion - Get the browser name and version +
- compareVersion - Version number size comparison, tag version:
rc>beta>alpha>other
+ - parseUrlParam - parse url params. (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2) +
- spliceUrlParam - Splice URL parameters (single layer only) +
- safeParse - Secure parsing of JSON strings +
- safeStringify - Secure stringify of JSON Object +
- getDirParam - Get the URL parameter in the form of a directory +
- getQueryParam - Get a single query parameter (behind "#") +
- getQueryParams - Get all query parameters (behind "#"). (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2) +
- getUrlParam - Get a single URL parameter (from the "location.search", before "#") +
- getUrlParams - Get all URL parameters (from the "location.search", before "#"). (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2) +
+ - localStorage & sessionStorage & Cookie
+
-
+
- getCache - Get the cache, if the deposited is Object, the retrieved is also Object, no need to convert again +
- setCache - Set the cache, if the deposited is Object, the retrieved is also Object, no need to convert again +
- delCache - Delete localStorage +
- getSession - Get the session, if the deposited is Object, the retrieved is also Object, no need to convert again +
- setSession - Set the session, if the deposited is Object, the retrieved is also Object, no need to convert again +
- delSession - Delete sessionStorage +
- getCookie - Get cookie by name +
- getCookies - Get all cookies +
- setCookie - Set cookie +
- delCookie - Delete cookie +
+ - Base64 & UTF8
+
-
+
- encodeBase64 - convert strings, numbers to base64 +
- decodeBase64 - base64 decoding +
- encodeUtf8 - convert strings, numbers to utf8 +
- decodeUtf8 - utf8 decoding +
+ - Events
+
-
+
- stopBubble - stop bubbling +
- stopDefault - stop default events +
- addEvent - event delegate, support multiple delegates +
- removeEvent - removeEvent removes the event delegate created by addEvent +
- getScrollPosition - Get slide to top and bottom return 'top' 'bottom', recommend using limit flow +
+ - Utilities
+
-
+
- nextIndex - return the next zIndex value +
- nextVersion - return the next version, Only version types with no more than 3 digits are supported. (Follow the npm version rules) +
- punctualTimer - punctual setInterval +
- promiseFactory - Convert an object to a promise like api +
- fixNumber - truncate a few decimal places, not 0 for shortage +
- mapTemplate - Replacing specific data in a template string, support
${xxxx}{{xxxx}}and{xxxx}
+ - extend - deep copy & merge objects +
- clone - deep copy (Buffer, Promise, Set, Map are not supported) +
- delay - anti-dither throttling +
- getType - Get the target type +
- getFileType - Determine file type based on link suffix +
- sorter - Sorter factory function +
- sortPinyin - Sort Chinese by Chinese phonetic alphabet +
- cleanData - Data cleaning methods +
- download - Several ways of file downloading +
- searchObject - tree object depth lookup +
- openUrl - Open link in new tab (file jump download if browser can't parse) +
- copy - copy to clipboard +
- toThousands - Digital thousandths division +
- all - return true if the provided predicate function returns true for all elements in a set, otherwise return false +
- any - Returns true if the provided predicate function returns true for at least one element of a set, false otherwise +
- uuid - generate uuid on browser side, use v4 method +
- CSVToArray - Converts a comma-separated string of values (CSV) to a 2D array. +
- arrayToCSV - Converts a two-dimensional array to a comma-separated string of values (CSV). +
- CSVToJSON - Converts a comma-separated string of values (CSV) to an array of 2D objects. The first line of the string is used as the header line. +
- JSONToCSV - Converts an array of objects to a comma-separated value (CSV) string containing only the specified columns. +
- RGBToHex - Converts RGB component values to color codes. +
- intersect - Find the intersection of multiple arrays +
- union - Find the concatenation of multiple arrays +
- minus - Find the set of differences of multiple arrays that belong to A but not to B/C/D... of the elements of +
- complement - Find the complement of multiple arrays +
- contains - Whether the array contains the specified element +
- unique - Array de-duplication +
- fillIPv6 - ipv6 address completion +
- getProperty - Get array, object property values based on path string +
- setProperty - Set array, object property values based on path string +
- loadSource - load resources dynamically, support js, images, css links, css style strings +
- mountCss - dynamically load css link resources +
- mountImg - load image resource dynamically +
- mountJs - load js link resources dynamically +
- mountStyle - load css styles dynamically +
- preloader - Image preloading +
- waiting - waiting for a while +
- awaitTo - Async await wrapper for easy error handling +
+ - Blob arrayBuffer base64 file blobUrl
+
-
+
- arrayBufferToBase64 - arrayBuffer to base64 +
- arrayBufferToBlob - arrayBuffer to blob +
- base64ToArrayBuffer - base64 to arrayBuffer +
- base64ToBlob - base64 to blob +
- base64ToFile - base64 to file +
- blobToArrayBuffer - blob to arrayBuffer +
- blobToBase64 - blob to base64 +
- blobToUrl - blob to url +
- fileToBase64 - file to base64 +
- svgToBlob - svg to blob +
- urlToBlob - url to blob +
+
+ - Support & Issues +
- License +
Installation
# use pnpm
pnpm install js-cool
## use npm
npm install --save js-cool
+Usage
ES6 module
import { osVersion } from 'js-cool'
osVersion()
+Node.js require
const { osVersion } = require('js-cool')
osVersion()
+Using unpkg CDN
<script src="https://unpkg.com/js-cool@latest/dist/index.global.prod.js"></script>
<script>
jsCool.browserVersion()
</script>
+API Reference
Global Parameters
client
The client method returns a browser result object
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+none
+ -
+
Returns:
+object
+ -
+
Example:
+
+
import { client } from 'js-cool'
client.get(['device', 'browser', 'engine', 'os']) // { device: 'xxx', browser: 'xxx', os: 'xxx', engine: 'xxx' }
client.get('device') // { device: 'xxx' }
+-
+
- Types: +
declare class Client {
matchMap: Record<InfoKeys, boolean>
root: Window & typeof globalThis
navigator: Navigator
constructor(options: ClientOptions)
get(names?: InfoTypes | InfoTypes[]): Partial<{
device: InfoKeys | undefined
os: InfoKeys | undefined
browser: InfoKeys | undefined
engine: InfoKeys | undefined
language: any
network: any
orientation: string | undefined
}>
getInfoByType(infoKey: InfoKey): InfoKeys | undefined
getOrientationStatus(): 'vertical' | 'horizontal' | undefined
getNetwork(): any
getLanguage(): any
}
+pattern
Collection of common regular expressions
+++v5.21.2
+patternsupport mac/ip4/ip4_pri
-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+none
+ -
+
Returns:
+none
+ -
+
Example:
+
+
pattern.number.test('333') // true
+-
+
- Types: +
declare const pattern: {
any: RegExp
number: RegExp
string: RegExp
postcode: RegExp
url: RegExp
username: RegExp
float: RegExp
email: RegExp
mobile: RegExp
chinese: RegExp
tel: RegExp
qq: RegExp
pass: RegExp
json: RegExp
arrjson: RegExp
array: RegExp
isjson: RegExp
textarea: RegExp
mac: RegExp
ip4: RegExp
ip4_pri: RegExp
}
+Extras for String & Array & Object & Function
clearAttr
Remove all attributes of HTML tags
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| string | +string with html tags | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
clearAttr('<div id="testID">test</div>')
// '<div>test</div>'
+-
+
- Types: +
declare function clearAttr(string: string): string
+clearHtml
Remove HTML tags
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| string | +string with html tags | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
clearHtml('<div>test<br />string</div>')
// 'teststring'
+-
+
- Types: +
declare function clearHtml(string: string): string
+escape
Escaping HTML Special Characters
+-
+
-
+
Since:
+5.5.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| string | +string with html tags | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
escape('<div>test<br />string</div>')
// '<div>test<br />string</div>'
+-
+
- Types: +
declare function escape(string: string): string
+unescape
Restore HTML Special Characters
+-
+
-
+
Since:
+5.5.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| string | +string | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
unescape('<div>test<br />string</div>')
// '<div>test<br />string</div>'
+-
+
- Types: +
declare function unescape(string: string): string
+getNumber
Get the number in the string
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| string | +pass in a string with a number | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
getNumber('Chrome123.33')
// '123.33'
getNumber('234test.88')
// '234.88'
+-
+
- Types: +
declare function getNumber(string: string): string
+camel2Dash
Converts humped strings to -spaced and all lowercase Dash pattern
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| string | +the string to be converted | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
camel2Dash('jsCool') // js-cool
+-
+
- Types: +
declare function camel2Dash(string: string): string
+dash2Camel
Converts -spaced and all lowercase Dash patterns to humped strings
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| string | +the string to be converted | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
dash2Camel('js-cool') // jsCool
+-
+
- Types: +
declare function dash2Camel(string: string): string
+randomColor
Generate random hexadecimal colors
+++Support for custom color value ranges starting with version 5.17.0, which can be used to customize the generation of darker, lighter, warmer colors, etc.
+
-
+
-
+
Since:
+5.5.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| min | +the minimum value of the random numbers | +number / [number, number, number] |
+- | +false |
+- | +
| max | +the maximum value of the random numbers | +number / [number, number, number] |
+- | +false |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
randomColor()
// #bf444b
randomColor(200)
// #d6e9d7
randomColor(200, 255)
// #d3f9e4
randomColor([0, 0, 0], [255, 255, 255])
// #e2f2f3
+-
+
- Types: +
declare function randomColor(
min?: number | [number, number, number],
max?: number | [number, number, number]
): string
+randomNumber
Get a random number
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| min | +the minimum value of the random number | +number |
+- | +false |
+1 | +
| max | +the maximum value of the random number | +number |
+- | +false |
+10 | +
-
+
-
+
Returns:
+number
+ -
+
Example:
+
+
randomNumber() // 8
randomNumber(0.1, 0.9) // 0.8
+-
+
- Types: +
declare function randomNumber(min?: number, max?: number): number
+randomNumbers
Generate n random integers that sum to a fixed sum
+-
+
-
+
Since:
+5.4.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| n | +Number of generated integers | +number |
+- | +false |
+1 | +
| sum | +Sum of generated integers | +number |
+- | +false |
+100 | +
| noZero | +Generate integers that are not zero | +boolean |
+- | +false |
+true |
+
-
+
-
+
Returns:
+Array<number>
+ -
+
Example:
+
+
randomNumbers()
// [8]
randomNumbers(4, 5)
// [1, 1, 2, 1]
randomNumbers(4, 5, false)
// [0, 1, 2, 2]
+-
+
- Types: +
declare function randomNumbers(n?: number, sum?: number): number[]
+randomString
Get a random string
+++v5.4.0
+widthSpecialCharchanged tooptions, still compatible with old usage, widthSpecialChar=true equivalent to { charTypes: ['uppercase', 'lowercase', 'number', 'special'] }
-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| len | +the length of the random string that needs to be obtained | +number |
+- | +false |
+32 | +
| options | +randomString options | +RandomStringOptions boolean |
+- | +false |
+{ charTypes: ['uppercase', 'lowercase', 'number'] } |
+
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
// 1. No parameters are passed, a 32-bit (possibly) string containing upper and lower case letters and numbers is generated by default
randomString()
// PVSjz902EqYbmxaLtvDnggtnlvt5uFTZ
// 2. Generate a 16-bit random string
randomString(16)
// coTgZy0mqqMJ1sMM
// 3. Same effect as #2 above
randomString({
length: 16
})
// ngCI5aPqJm84t90d
// 4. Generate containing special characters (old way of passing values, not recommended)
randomString(true)
// 0Uby@op3B-sK5]dHl4S|15As.OlHiNXd
// 5. Same effect as #4 above (recommended)
randomString({
charTypes: ['uppercase', 'lowercase', 'number', 'special']
})
// m,2^vpkrE,F,DbcSFk0=vr&@DJ27j9XK
// 6. Same effect as #4 above, Limit string length to 16 bits
randomString(16, true)
// dXz[J_sYM^3d8fnA
// 7. Generate a 16-bit random number
randomString({
length: 16,
charTypes: 'number'
})
// 7450026301030286
// 8. Elimination of confusing characters: oOLl,9gq,Vv,Uu,I1
randomString({
length: 16,
noConfuse: true
})
// 8DEGna8ppC4mqyew
// 9. The generated random string must contain at least 1 character of each type of character specified, e.g. to generate a 16-bit password that must contain upper and lower case letters, numbers, and special characters.
randomString({
length: 16,
strict: true
})
// PFYAPD5KFqOHIADL
+-
+
- Types: +
declare function randomString(len?: number, options?: RandomStringOptions | boolean): string
declare function randomString(
len?: RandomStringOptions | boolean,
options?: RandomStringOptions | boolean
): string
declare type RandomStringCharType = 'uppercase' | 'lowercase' | 'number' | 'special'
declare interface RandomStringOptions {
length?: number
charTypes?: RandomStringCharType | ArrayOneMore<RandomStringCharType>
/**
* Elimination of confusing characters: oOLl,9gq,Vv,Uu,I1
*/
noConfuse?: boolean
/**
* The generated random string must contain each of the listed character types
*/
strict?: boolean
}
+shuffle
shuffling algorithm, Reordering arrays or strings
+-
+
-
+
Since:
+5.4.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| value | +arrays or strings | +array string |
+- | +true |
+- | +
| size | +new array or string length | +number |
+- | +false |
+- | +
-
+
-
+
Returns:
+array | string
+ -
+
Example:
+
+
const str = 'abcde'
const arr = [1, 2, 3]
shuffle(str)
// cdbse
shuffle(arr)
// [3, 1, 2]
shuffle(arr, 2)
// [3, 2]
+-
+
- Types: +
declare function shuffle(value: string, size?: number): string
declare function shuffle<T extends unknown[] = unknown[]>(value: T, size?: number): T
+fingerprint
Generating Browser Fingerprints
+-
+
-
+
Since:
+5.2.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| domain | +key string | +string |
+- | +false |
+location.host | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
fingerprint('www.saqqdy.com') // wc7sWJJA8
+-
+
- Types: +
declare function fingerprint(domain?: string): string | null
+getCHSLength
Get the length of the string, Chinese counts as 2 characters
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| str | +input string | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+number
+ -
+
Example:
+
+
getCHSLength('测试') // 2
+-
+
- Types: +
declare function getCHSLength(str: string): number
+cutCHSString
Intercept string, Chinese counts as 2 bytes
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| str | +the string to be intercepted | +string |
+- | +true |
+- | +
| len | +length | +number |
+- | +false |
+- | +
| hasDot | +output with dot | +boolean |
+- | +false |
+false |
+
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
cutCHSString('测试', 1) // 测
cutCHSString('测试', 1, true) // 测...
+-
+
- Types: +
declare function cutCHSString(str: string, len?: number, hasDot?: boolean): string
+upperFirst
First letter capitalized
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| string | +the string to be converted | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
upperFirst('saqqdy') // Saqqdy
+-
+
- Types: +
declare function upperFirst(string: string): string
+Determine
isDigitals
Determine if a string is a number
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| str | +the string to be tested | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isDigitals('2.11') // true
isDigitals('2.3x') // false
+-
+
- Types: +
declare function isDigitals(str: string): boolean
+isExitsFunction
Determine if a function is defined
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +function name | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isExitsFunction('test') // false
isExitsFunction('console.log') // true
+-
+
- Types: +
declare function isExitsFunction(name: string): boolean
+isExitsVariable
Determine if a variable is defined
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +variable name | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isExitsVariable('test') // false
isExitsVariable('window') // true
+-
+
- Types: +
declare function isExitsVariable(name: string): boolean
+isEqual
Determine if 2 objects are equal
+-
+
-
+
Since:
+5.12.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| a | +source | +any |
+- | +true |
+- | +
| b | +compare | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isEqual({ a: 22, b: {} }, { b: {}, a: 22 })
// true
isEqual([1, 2], [2, 1])
// false
isEqual(NaN, NaN)
// true
+-
+
- Types: +
declare function isEqual<T, P>(a: T, b: P): boolean
+isWindow
Determine if window object
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +any target | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isWindow({}) // false
isWindow(window) // true
+-
+
- Types: +
declare function isWindow<T = any>(target: T): target is Window
+isPlainObject
Determine if target is an plain object
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +any target | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isPlainObject({}) // true
isPlainObject(window) // false
+-
+
- Types: +
type Primitive = bigint | boolean | null | number | string | symbol | undefined
type JSONValue = Primitive | PlainObject | JSONArray
// eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style
interface PlainObject {
[key: string]: JSONValue
}
interface JSONArray extends Array<JSONValue> {}
declare function isPlainObject(target: unknown): target is PlainObject
+isDarkMode
Determine if dark color mode
+-
+
-
+
Since:
+5.5.0
+ -
+
Arguments: none
+
+ -
+
Returns:
+boolean
+ -
+
Example:
+
+
isDarkMode() // false
+-
+
- Types: +
declare function isDarkMode(): boolean
+isObject
Determine if target is an object
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +any target | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isObject({}) // true
+-
+
- Types: +
declare function isObject<T = any>(target: T): target is Object
+isDate
Determine if target is Date
+-
+
-
+
Since:
+5.15.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +any target | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
const now = new Date()
isDate(now)
// true
+-
+
- Types: +
declare function isDate<T = any>(target: T): target is Date
+isRegExp
Determine if target is RegExp
+-
+
-
+
Since:
+5.15.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +any target | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isRegExp(/\d/) // true
+-
+
- Types: +
declare function isRegExp<T = any>(target: T): target is RegExp
+isArray
Determine if it is an array
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +any target | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isArray([]) // true
+-
+
- Types: +
declare function isIterable(target: any): target is any[]
+isIterable
Determine if it is iterable
+-
+
-
+
Since:
+5.7.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +any target | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
isIterable([]) // true
+-
+
- Types: +
declare function isIterable<T = any>(target: T | Iterable<T>): target is Iterable<T>
+inBrowser
Determine if it is running on the browser side
+-
+
-
+
Since:
+4.5.0
+ -
+
Arguments:
+none
+ -
+
Returns:
+boolean
+ -
+
Example:
+
+
function test() {
if (!inBrowser) return null
// ...
}
+-
+
- Types: +
declare const inBrowser: boolean
+inNodeJs
Determine if it is running on node.js
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+none
+ -
+
Returns:
+boolean
+ -
+
Example:
+
+
if (inNodeJs) {
//
}
+-
+
- Types: +
declare const inNodeJs: boolean
+isNumberBrowser
Detect if the client is a 360 browser
+-
+
-
+
Since:
+5.22.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| userAgent | +ua or any ua like string, allowed to be undefined | +string |
+- | +false |
+navigator.userAgent |
+
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
// 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.6261.95 Safari/537.36 QIHU 360EE'
// true
// 'Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.6261.95 Safari/537.36'
// true
+-
+
- Types: +
declare function isNumberBrowser(userAgent?: string): boolean
+windowSize
Get the window size
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+none
+ -
+
Returns:
+{ width, height }
+ -
+
Example:
+
+
windowSize()
// { width: 1280, height: 800 }
+-
+
- Types: +
declare interface WindowSizeObj {
width: number
height: number
}
declare function windowSize(): WindowSizeObj
+getAppVersion
Get the APP version number
+++deprecated please use 'appVersion' instead
+
-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| appName | +app name | +string |
+- | +true |
+- | +
| withApp | +whether to bring the name | +boolean |
+- | +false |
+- | +
| userAgent | +ua or any ua like string, allowed to be undefined | +string |
+- | +false |
+navigator.userAgent |
+
-
+
-
+
Returns:
+string | boolean | null
+ -
+
Example:
+
+
// navigator.userAgent => '5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 AppName/1.0.0-beta.8'
getAppVersion('Chrome') // 114.0.0.0
getAppVersion('Safari', true) // Safari/537.36
+-
+
- Types: +
declare function getAppVersion(
appName: string,
withApp?: boolean,
userAgent?: string
): string | boolean | null
+appVersion
Get the app version number
+-
+
-
+
Since:
+5.1.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| appName | +app name | +string |
+- | +true |
+- | +
| ua | +ua or any ua like string, allowed to be undefined | +string |
+- | +false |
+navigator.userAgent | +
| ignoreCase | +whether to ignore case | +boolean |
+true/false |
+false |
+true |
+
-
+
-
+
Returns:
+string | null
+ -
+
Example:
+
+
// navigator.userAgent => '5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 AppName/1.0.0-beta.8'
appVersion('Chrome') // 114.0.0.0
appVersion('Safari') // 537.36
appVersion('appname', false) // null
appVersion('appname') // 1.0.0-beta.8
+-
+
- Types: +
declare function appVersion(appName: string): string | null
declare function appVersion(appName: string, ua: string): string | null
declare function appVersion(appName: string, ua: boolean): string | null
declare function appVersion(appName: string, ua: string, ignoreCase: boolean): string | null
+getOsVersion
Get the phone system version
+++deprecated: please use 'osVersion' instead
+
-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| osName | +system type string Android, iPod, iWatch or iPhone | +string |
+- | +true |
+- | +
| withOS | +whether to bring the name | +string |
+- | +false |
+- | +
| userAgent | +ua or any ua like string, allowed to be undefined | +string |
+- | +false |
+navigator.userAgent |
+
-
+
-
+
Returns:
+string | boolean | null
+ -
+
Example:
+
+
getOsVersion('iPhone')
// '13.2.3'
getOsVersion('iPhone', true)
// 'iPhone/13.2.3'
+-
+
- Types: +
declare function getOsVersion(
osName: string,
withOS?: boolean,
userAgent?: string
): string | boolean | null
+osVersion
get the system version
+-
+
-
+
Since:
+5.1.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| ua | +ua or any ua like string, allowed to be undefined | +string |
+- | +false |
+navigator.userAgent | +
-
+
-
+
Returns:
+OsVersion | null
+ -
+
Example:
+
+
// ipad => 'Mozilla/5.0 (iPad; CPU OS 13_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/87.0.4280.77 Mobile/15E148 Safari/604.1'
osVersion() // \{ name: 'iOS', version: '13.3' \}
// iphone => 'Mozilla/5.0 (iPhone; CPU iPhone OS 13_2_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Mobile/15E148 Safari/604.1'
osVersion() // \{ name: 'iOS', version: '13.2.3' \}
// mac os => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36'
osVersion() // \{ name: 'MacOS', version: '10.15.7' \}
// windows => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36'
osVersion() // \{ name: 'Windows', version: '10.0' \}
// windows xp => 'Mozilla/5.0 (Windows NT 5.2; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36'
osVersion() // \{ name: 'Windows', version: 'XP' \}
// windows phone => 'Mozilla/5.0 (Windows Phone OS 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.82 Safari/537.36'
osVersion() // \{ name: 'WindowsPhone', version: '10.0' \}
+-
+
- Types: +
declare interface OsVersion {
name: 'Windows' | 'MacOS' | 'Android' | 'iOS' | 'WindowsPhone' | 'Debian' | 'WebOS' | 'Harmony'
version: string
}
declare function osVersion(ua?: string): OsVersion | null
+browserVersion
Get the browser name and version
+-
+
-
+
Since:
+5.2.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| ua | +ua or any ua like string, allowed to be undefined | +string |
+- | +false |
+navigator.userAgent | +
-
+
-
+
Returns:
+BrowserVersion | null
+ -
+
Example:
+
+
// Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Ap…KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36
browserVersion() // \{ name: 'Chrome', version: '114.0.0.0' \}
+-
+
- Types: +
declare interface BrowserVersion {
name:
| 'Safari'
| 'Chrome'
| 'IE'
| 'Edge'
| 'Firefox'
| 'Firefox Focus'
| 'Chromium'
| 'Opera'
| 'Vivaldi'
| 'Yandex'
| 'Arora'
| 'Lunascape'
| 'QupZilla'
| 'Coc Coc'
| 'Kindle'
| 'Iceweasel'
| 'Konqueror'
| 'Iceape'
| 'SeaMonkey'
| 'Epiphany'
| '360'
| '360SE'
| '360EE'
| 'Maxthon'
| 'QQBrowser'
| 'QQ'
| 'Baidu'
| 'UC'
| 'Sogou'
| 'Liebao'
| 'LBBROWSER'
| '2345Explorer'
| '115Browser'
| 'TheWorld'
| 'XiaoMi'
| 'Vivo'
| 'Quark'
| 'Qiyu'
| 'Wechat'
| 'WechatWork'
| 'Taobao'
| 'Alipay'
| 'Weibo'
| 'Douban'
| 'Suning'
| 'iQiYi'
| 'DingTalk'
| 'Huawei'
version: string
}
declare function browserVersion(ua?: string): BrowserVersion | null
+compareVersion
++v5.8.0 support compare tag version
+
Version number size comparison, tag version: rc > beta > alpha > other
-
+
-
+
Since:
+4.7.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +input version | +string |
+- | +true |
+- | +
| compare | +compare version | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+0 | 1 | -1
+ -
+
Example:
+
+
compareVersion('1.11.0', '1.9.9')
// => 1: 1=Version 1.11.0 is newer than 1.9.9
compareVersion('1.11.0', '1.11.0')
// => 0: 0=Versions 1.11.0 and 1.11.0 are the same
compareVersion('1.11.0', '1.99.0')
// => -1: -1=Version 1.11.0 is older than 1.99.0
compareVersion('1.0.0.0.0.10', '1.0')
// => -1
// compare tag version: rc > beta > alpha > other
compareVersion('1.11.0', '1.11.0-beta.1')
// => -1
compareVersion('1.11.0-beta.1', '1.11.0')
// => -1
compareVersion('1.11.0-beta.10', '1.11.0-beta.10')
// => 0
compareVersion('1.11.0-alpha.10', '1.11.0-beta.1')
// => -1
compareVersion('1.11.0-alpha.10', '1.11.0-rc.1')
// => -1
compareVersion('1.11.0-tag.10', '1.11.0-alpha.1')
// => -1
compareVersion('1.11.0-tag.10', '1.11.0-tag.1')
// => 1
compareVersion('1.11.0-release.10', '1.11.0-tag.1')
// => 1
+-
+
- Types: +
declare function compareVersion(input: string, compare: string): 0 | 1 | -1
+parseUrlParam
parse url params. (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +url string (like: ?key1=value1&key2=value2) | +string |
+- | +true |
+- | +
| covert | +Converts a specific string to a corresponding value | +boolean |
+true/false |
+false |
+false |
+
-
+
-
+
Returns:
+object
+ -
+
Example:
+
+
parseUrlParam(
'?key1=100&key2=true&key3=null&key4=undefined&key5=NaN&key6=10.888&key7=Infinity&key8=test'
)
// \{"key1":"100","key2":"true","key3":"null","key4":"undefined","key5":"NaN","key6":"10.888","key7":"Infinity","key8":"test"\}
parseUrlParam(
'?key1=100&key2=true&key3=null&key4=undefined&key5=NaN&key6=10.888&key7=Infinity&key8=test',
true
)
// \{"key1":100,"key2":true,"key3":null,"key5":NaN,"key6":10.888,"key7":Infinity,"key8":"test"\}
+-
+
- Types: +
declare function parseUrlParam(url: string, covert?: boolean): Record<string, unknown>
+spliceUrlParam
Splice URL parameters (single layer only)
+++v5.20.0 Breaking change: remove encodeURIComponent +v5.21.0 Breaking change: covert support boolean & SpliceUrlParamOptions
+
-
+
-
+
Since:
+5.3.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| params | +json object | +object |
+- | +true |
+- | +
| covert | +Convert a null value type (null/undefined/) to an empty string or spliceUrlParamOptions | +boolean | SpliceUrlParamOptions |
+- | +false |
+false |
+
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
spliceUrlParam({ key1: '100', key2: true, key3: null, key4: undefined, key5: '测试' })
// ?key1=100&key2=true&key3=null&key4=undefined&key5=测试
spliceUrlParam(
{ key1: '100', key2: true, key3: null, key4: undefined, key5: '测试' },
{ encode: true }
)
// ?key1=100&key2=true&key3=null&key4=undefined&key5=%E6%B5%8B%E8%AF%95
spliceUrlParam({ key1: '100', key2: true, key3: null, key4: undefined }, true)
// ?key1=100&key2=true&key3=&key4=
spliceUrlParam(
{ key1: '100', key2: true, key3: null, key4: undefined },
{ covert: true, withQuestionsMark: false }
)
// key1=100&key2=true&key3=&key4=
+-
+
- Types: +
declare function spliceUrlParam<T extends Record<string, unknown>>(
params: T,
covert?: SpliceUrlParamOptions | boolean
): string
declare interface SpliceUrlParamOptions {
covert?: boolean
encode?: boolean
withQuestionsMark?: boolean
}
+safeParse
Secure parsing of JSON strings
+++support BigInt since
+v5.17.1
-
+
-
+
Since:
+5.16.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| data | +JSON string | +string |
+- | +true |
+- | +
| covert | +Whether to convert data | +boolean |
+true/false |
+false |
+true |
+
-
+
-
+
Returns:
+Object
+ -
+
Example:
+
+
safeParse('100')
// 100
safeParse('{"a":"undefined","b":"NaN","c":"Infinity","d":"9007199254740993"}')
// { b: NaN, c: Infinity, d: 9007199254740993n }
+-
+
- Types: +
declare function safeParse(data: string, covert?: boolean): any
+safeStringify
Secure stringify of JSON Object
+++support BigInt since
+v5.17.1
-
+
-
+
Since:
+5.16.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| data | +JSON Object | +any |
+- | +true |
+- | +
| covert | +Whether to convert data | +boolean |
+true/false |
+false |
+true |
+
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
safeStringify(100)
// "100"
safeStringify(undefined)
// "undefined"
safeStringify(NaN)
// "NaN"
safeStringify(Infinity)
// "Infinity"
safeStringify({ a: undefined, b: NaN, c: Infinity, d: BigInt(Number.MAX_SAFE_INTEGER) + 2n })
// {"a":"undefined","b":"NaN","c":"Infinity","d":"9007199254740993"}
+-
+
- Types: +
declare function safeStringify(data: any, covert?: boolean): string
+getDirParam
Get the URL parameter in the form of a directory
+++It will be refactored and renamed getDirParams in the next major release.
+
-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +http url | +object |
+- | +true |
+- | +
-
+
-
+
Returns:
+object
+ -
+
Example:
+
+
//
+-
+
- Types: +
declare interface DirParamType {
path?: string[]
host?: string
}
declare function getDirParam(url: string): DirParamType
+getQueryParam
Get a single query parameter (behind "#")
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| key | +key name | +string |
+- | +true |
+- | +
| url | +pass in the url string | +string |
+- | +false |
+location.href |
+
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
getQueryParam('key1')
// key1 => xxx
getQueryParam('key1', 'https://test.com?key1=100#/home?key1=200')
// key1 => 200
+-
+
- Types: +
declare function getQueryParam(key: string): string | undefined
declare function getQueryParam(key: string, url: string): string | undefined
+getQueryParams
Get all query parameters (behind "#"). (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +pass in the url string | +string |
+- | +false |
+location.href |
+
| covert | +Converts a specific string to a corresponding value | +boolean |
+true/false |
+false |
+false |
+
-
+
-
+
Returns:
+object
+ -
+
Example:
+
+
getQueryParams('https://test.com?key1=100#/home?key1=200')
// \{"key1":"200"\}
getQueryParams('https://test.com?key1=100#/home?key1=200', true)
// \{"key1":200\}
getQueryParams(true)
// \{"key1":200\}
+-
+
- Types: +
declare function getQueryParams(url?: string, covert?: boolean): Record<string, unknown> | null
+getUrlParam
Get a single URL parameter (from the "location.search", before "#")
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| key | +key name | +string |
+- | +true |
+- | +
| url | +pass in the url string | +string |
+- | +false |
+location.href |
+
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
getUrlParam('key1')
// key1 => xxx
getUrlParam('key1', 'https://test.com?key1=100#/home?key1=200')
// key1 => 100
+-
+
- Types: +
declare function getUrlParam(key: string): string | undefined
declare function getUrlParam(key: string, url: string): string | undefined
+getUrlParams
Get all URL parameters (from the "location.search", before "#"). (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +pass in the url string | +string |
+- | +false |
+location.href |
+
| covert | +Converts a specific string to a corresponding value | +boolean |
+true/false |
+false |
+false |
+
-
+
-
+
Returns:
+object
+ -
+
Example:
+
+
getUrlParams('https://test.com?key1=100#/home?key1=200')
// \{"key1":"100"\}
getUrlParams('https://test.com?key1=100#/home?key1=200', true)
// \{"key1":100\}
getUrlParams(true)
// \{"key1":100\}
+-
+
- Types: +
declare function getUrlParams(url?: string, covert?: boolean): Record<string, unknown> | null
+localStorage & sessionStorage & Cookie
getCache
Get the cache, if the deposited is Object, the retrieved is also Object, no need to convert again
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +cache key name | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+any
+ -
+
Example:
+
+
import { getCache, setCache } from 'js-cool'
const data1 = 100
const data2 = { a: 10 }
const data3 = null
setCache('data1', data1)
setCache('data2', data2)
setCache('data3', data3)
getCache('data1') // 100
getCache('data2') // {a:10}
getCache('data3') // null
getCache('data4') // null
+-
+
- Types: +
declare function getCache(name: string): any
+setCache
Set the cache, if the deposited is Object, the retrieved is also Object, no need to convert again
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +cache key name | +string |
+- | +true |
+- | +
| value | +cache data, can be passed directly into Object | +any |
+- | +true |
+- | +
| seconds | +cache time (seconds) | +number |
+- | +false |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
import { getCache, setCache } from 'js-cool'
const data1 = 100
const data2 = { a: 10 }
const data3 = null
setCache('data1', data1)
setCache('data2', data2, 10)
getCache('data1') // 100
getCache('data2') // {a:10}
setTimeout(() => {
getCache('data2') // null
}, 15000)
+-
+
- Types: +
declare function setCache<T = unknown>(name: string, value: T, seconds?: number | string): void
+delCache
Delete localStorage
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +cache key name | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
delCache('data')
+-
+
- Types: +
declare function delCache(name: string): void
+getSession
Get the session, if the deposited is Object, the retrieved is also Object, no need to convert again
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +session key name | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+any
+ -
+
Example:
+
+
const data1 = 100
const data2 = { a: 10 }
const data3 = null
setSession('data1', data1)
setSession('data2', data2)
setSession('data3', data3)
getSession('data1') // 100
getSession('data2') // {a:10}
getSession('data3') // null
getSession('data4') // null
+-
+
- Types: +
declare function getSession(name: string): any
+setSession
Set the session, if the deposited is Object, the retrieved is also Object, no need to convert again
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +session key name | +string |
+- | +true |
+- | +
| value | +session data, can be passed directly into Object | +any |
+- | +true |
+- | +
| seconds | +session time (seconds) | +number |
+- | +false |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
import { getSession, setSession } from 'js-cool'
const data1 = 100
const data2 = { a: 10 }
const data3 = null
setSession('data1', data1)
setSession('data2', data2, 10)
getSession('data1') // 100
getSession('data2') // {a:10}
setTimeout(() => {
getSession('data2') // null
}, 15000)
+-
+
- Types: +
declare function setSession<T = unknown>(name: string, value: T, seconds?: number | string): void
+delSession
Delete sessionStorage
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +session key name | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
delSession('data')
+-
+
- Types: +
declare function delSession(name: string): void
+getCookie
Get cookie by name
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +cookie key name | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+any
+ -
+
Example:
+
+
getCookie('data1') // 100
+-
+
- Types: +
declare function getCookie(name: string): string
+getCookies
Get all cookies
+-
+
-
+
Since:
+5.6.0
+ -
+
Arguments: 'none'
+
+ -
+
Returns:
+object
+ -
+
Example:
+
+
getCookies()
// { token: 'xxx', name: 'saqqdy' }
+-
+
- Types: +
declare function getCookies(): Record<string, string>
+setCookie
Set cookie
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +cookie key name | +string |
+- | +true |
+- | +
| value | +cookie data, can be passed directly into Object | +any |
+- | +true |
+- | +
| seconds | +cookie time (seconds) | +number |
+- | +false |
+- | +
| path | +cookie path | +string |
+- | +false |
+/ |
+
| samesite | +SameSite type | +string |
+Strict/Lax /None |
+false |
+None |
+
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
import { getCookie, setCookie } from 'js-cool'
const data1 = 100
const data2 = 200
setCookie('data1', data1)
setCookie('data2', data2, 10)
getCookie('data1') // 100
getCookie('data2') // 200
setTimeout(() => {
getCookie('data2') // null
}, 15000)
+-
+
- Types: +
declare function setCookie<T extends string | number | boolean>(
name: string,
value: T,
seconds: string | number,
path?: string,
samesite?: boolean
): void
+delCookie
Delete cookie
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| name | +cookie key name | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
delCookie('data')
+-
+
- Types: +
declare function delCookie(name: string): void
+Base64 & UTF8
encodeBase64
convert strings, numbers to base64
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +the string to be encoded | +string/number |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
encodeBase64('data')
+-
+
- Types: +
declare function encodeBase64(name: string): string
+decodeBase64
base64 decoding
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +the string to be decoded | +string/number |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
decodeBase64('data')
+-
+
- Types: +
declare function decodeBase64(name: string): string
+encodeUtf8
convert strings, numbers to utf8
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +the string to be encoded | +string/number |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
encodeUtf8('data')
+-
+
- Types: +
declare function encodeUtf8(name: string): string
+decodeUtf8
utf8 decoding
+-
+
-
+
Since:
+1.0.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +the string to be decoded | +string/number |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
decodeUtf8('data')
+-
+
- Types: +
declare function decodeUtf8(name: string): string
+Events
stopBubble
stop bubbling
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| e | +dom's event object | +Event |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
stopBubble(event)
+-
+
- Types: +
declare function stopBubble(e: Event): boolean
+stopDefault
stop default events
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| e | +dom's event object | +Event |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
stopDefault(event)
+-
+
- Types: +
declare function stopDefault(e: Event): boolean
+addEvent
event delegate, support multiple delegates
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| element | +js dom object | +HTMLElement |
+- | +true |
+- | +
| type | +The type of the event. No need to add on | +string |
+- | +true |
+- | +
| handler | +Callback method | +function |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
addEvent(document, 'click', functionName)
+-
+
- Types: +
declare function addEvent(element: AnyObject, type: string, handler: AnyFunction): void
+removeEvent
removeEvent removes the event delegate created by addEvent
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| element | +js dom object | +HTMLElement |
+- | +true |
+- | +
| type | +The type of the event. No need to add on | +string |
+- | +true |
+- | +
| handler | +Callback method | +function |
+- | +true |
+- | +
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
removeEvent(document, 'click', functionName)
+-
+
- Types: +
declare function removeEvent(element: AnyObject, type: string, handler: AnyFunction): void
+getScrollPosition
Get slide to top and bottom return 'top' 'bottom', recommend using limit flow
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+none
+ -
+
Returns: 'top' | 'bottom' | undefined
+
+ -
+
Example:
+
+
getScrollPosition() // ‘bottom’
+-
+
- Types: +
declare function getScrollPosition(): string | void
+Utilities
nextIndex
return the next zIndex value
+++change mix defaults to 0
+
-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| min | +minimum value | +number |
+- | +false |
+0 |
+
| max | +maximum value | +number |
+- | +false |
+- | +
-
+
-
+
Returns:
+number
+ -
+
Example:
+
+
nextIndex() // 1
nextIndex(1000) // 1001
nextIndex(10, 100) // 100
+-
+
- Types: +
declare function nextIndex(min?: number, max?: number): number
+nextVersion
return the next version, Only version types with no more than 3 digits are supported. (Follow the npm version rules)
+-
+
-
+
Since:
+5.10.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| version | +version(like: 1.0.0) | +string |
+- | +true |
+- | +
| type | +version type | +major | minor | patch | premajor | preminor | prepatch | prerelease |
+- | +false |
+patch |
+
| preid | +prerelease id | +string |
+- | +false |
+'' | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
nextVersion('1.2.33') // 1.2.34
nextVersion('1.2.33', 'major') // 2.0.0
nextVersion('1.2.33', 'premajor', 'alpha') // 2.0.0-alpha.1
+-
+
- Types: +
declare function nextVersion(
version: string,
type?: 'major' | 'minor' | 'patch' | 'premajor' | 'preminor' | 'prepatch' | 'prerelease',
preid?: string
): string
+punctualTimer
punctual setInterval
+++v5.23.0 got returns of PunctualTimerReturns
+
-
+
-
+
Since:
+5.18.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| handler | +A function to be executed after the timer expires. | +function |
+- | +true |
+- | +
| delay | +The time, in milliseconds that the timer should wait before the specified function or code is executed. If this parameter is omitted, a value of 0 is used, meaning execute "immediately", or more accurately, the next event cycle. | +number |
+- | +true |
+- | +
| ...args | +Additional arguments which are passed through to the function specified by handler. | +any[] |
+- | +false |
+- | +
-
+
-
+
Returns:
+PunctualTimerReturns
+ -
+
Example:
+
+
const printDate = () => console.log(new Date())
const timer = punctualTimer(printDate, 1000)
console.log(timer.count) // 10
timer.clear() // clear punctualTimer or use clearTimeout(timer.timer)
+-
+
- Types: +
declare function punctualTimer<TArgs extends any[]>(
handler: (args: void) => void,
delay: number,
[...args]?: TArgs
): PunctualTimerReturns
declare function punctualTimer<TArgs extends any[]>(
handler: (...args: TArgs) => void,
delay: number,
[...args]?: TArgs
): PunctualTimerReturns
declare interface PunctualTimerReturns {
count: number
timer: number | null
clear: () => void
}
+promiseFactory
Convert an object to a promise like api
+-
+
-
+
Since:
+5.10.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| original | +original object | +object |
+- | +true |
+- | +
| resolver | +resolver function | +Function |
+- | +true |
+- | +
-
+
-
+
Returns:
+T & PromiseLike<T>
+ -
+
Example:
+
+
import { promiseFactory, waiting } from 'js-cool'
function promise() {
const stats = {
value: 100
}
const resolver = () =>
new Promise(resolve =>
waiting(2000).then(() => {
stats.value = 200
resolve(stats)
})
)
return promiseFactory(stats, resolver)
}
const res = promise()
// res => 100
const res = await promise()
// res => 200
+-
+
- Types: +
declare function promiseFactory<T extends object>(
original: T,
resolver: () => Promise<any>
): T & PromiseLike<T>
+fixNumber
truncate a few decimal places, not 0 for shortage
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| number | +the number of digits to be processed | +number/string |
+- | +true |
+- | +
| n | +the number of decimal places to keep | +number |
+- | +false |
+2 |
+
-
+
-
+
Returns:
+string | number
+ -
+
Example:
+
+
fixNumber('100.888')
// 100.88
fixNumber('100.8', 2)
// 100.8
fixNumber('100.8888', 3)
// 100.888
+-
+
- Types: +
declare function fixNumber(number: string | number, n?: number): number
+mapTemplate
Replacing specific data in a template string, support ${xxxx} {{xxxx}} and {xxxx}
-
+
-
+
Since:
+5.9.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| tmp | +Template string | +string |
+- | +true |
+- | +
| data | +Template data of map function | +Function| Object |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
const tmp = "My name is ${name}, I'm ${age} years old."
mapTemplate(tmp, {
name: 'saqqdy',
age: 18
})
// My name is saqqdy, I'm 18 years old.
mapTemplate(tmp, key => ({ name: 'saqqdy', age: 28 })[key])
// My name is saqqdy, I'm 28 years old.
const tmp1 = "My name is {{name}}, I'm {{age}} years old."
mapTemplate(tmp1, {
name: 'saqqdy',
age: 18
})
// My name is saqqdy, I'm 18 years old.
+-
+
- Types: +
declare function mapTemplate(
tmp: string,
data: ((value: string) => unknown) | Record<string, unknown>
): string
+extend
deep copy & merge objects
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +boolean or array or object | +boolean/ArrayOneMore<ExtendData> |
+- | +true |
+- | +
| ...args | +array or object | +ArrayOneMore<ExtendData> |
+- | +true |
+- | +
-
+
-
+
Returns:
+array | object
+ -
+
Example:
+
+
extend(true, {}, {})
+-
+
- Types: +
declare function extend(
target: ExtendObjectData,
...args: ArrayOneMore<ExtendObjectData>
): ExtendObjectData
declare function extend(target: boolean, ...args: ArrayOneMore<ExtendObjectData>): ExtendObjectData
declare function extend(
target: ExtendArrayData,
...args: ArrayOneMore<ExtendArrayData>
): ExtendArrayData
declare function extend(target: boolean, ...args: ArrayOneMore<ExtendArrayData>): ExtendArrayData
declare type ExtendArrayData = any[]
declare type ExtendData = ExtendArrayData | ExtendObjectData
declare type ExtendObjectData = Record<string, any>
+clone
deep copy (Buffer, Promise, Set, Map are not supported)
+-
+
-
+
Since:
+5.15.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| source | +source object | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+object
+ -
+
Example:
+
+
const source = { a: 100, reg: /\d+/g, arr: [1, 2] }
const res = clone(source)
// { a: 100, reg: /\d+/g, arr: [1, 2] }
+-
+
- Types: +
declare function clone<T = any>(parent: T): T
+delay
anti-dither throttling
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+none
+ -
+
Returns:
+void
+ -
+
Example:
+
+
const delay = new Delay()
delay.register('key', () => {
//
})
+-
+
- Types: +
declare function delay(): {
map: any
register(id: string, fn: AnyFunction, time: number, boo: boolean): void
destroy(id: string): void
}
+getType
Get the target type
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +any target | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
getType({}) // object
getType([]) // array
getType(new Promise()) // promise
getType(new Date()) // date
getType(async () => {}) // function
getType(navigator) // navigator
getType(global) // global
getType(window) // window
getType(Symbol('')) // symbol
+-
+
- Types: +
declare function getType<T = any>(
target: T
):
| 'string'
| 'number'
| 'bigint'
| 'boolean'
| 'symbol'
| 'undefined'
| 'object'
| 'function'
| 'window'
| 'error'
| 'promise'
| 'math'
| 'document'
| 'navigator'
| 'global'
| 'array'
| 'date'
| 'regexp'
| 'null'
+getFileType
Determine file type based on link suffix
+-
+
-
+
Since:
+5.11.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +file url | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+object
+ -
+
Example:
+
+
getFileType('/name.png')
// { "suffix": "png", "type": "image" }
getFileType('/name.PDF')
// { "suffix": "pdf", "type": "pdf" }
getFileType('/name.xyz')
// { "suffix": "xyz", "type": "other" }
+-
+
- Types: +
declare function getFileType(url: string): {
suffix: string
type: 'audio' | 'video' | 'image' | 'other' | 'word' | 'txt' | 'excel' | 'pdf' | 'ppt' | 'zip'
}
+sorter
Sorter factory function
+-
+
-
+
Since:
+5.14.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| locales | +A string with a BCP 47 language tag, or an array of such strings | +string Array |
+- | +false |
+- | +
| options | +An object adjusting the output format. | +Intl.CollatorOptions |
+- | +false |
+- | +
-
+
-
+
Returns:
+Function
+ -
+
Example:
+
+
const items = ['啊我', '波拉', 'abc', 0, 3, '10', ',11', 13, null, '阿吧', 'ABB', 'BDD', 'ACD', 'ä']
items.sort(
sorter('zh-Hans-CN', {
ignorePunctuation: true,
sensitivity: 'variant',
numeric: true
})
)
// [ 0, 3, "10", ",11", 13, "ä", "ABB", "abc", "ACD", "BDD", null, "阿吧", "啊我", "波拉" ]
+-
+
- Types: +
declare function sorter(
locales?: string | string[],
options?: Intl.CollatorOptions
): <T = string, P = string>(a: T, b: P) => number
+sortPinyin
Sort Chinese by Chinese phonetic alphabet
+-
+
-
+
Since:
+5.14.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| a | +The first element for comparison. | +any |
+- | +true |
+- | +
| b | +The second element for comparison. | +any |
+- | +true |
+- | +
| options | +An object adjusting the output format. | +Intl.CollatorOptions |
+- | +false |
+- | +
-
+
-
+
Returns:
+number
+ -
+
Example:
+
+
const items = ['啊我', '波拉', 'abc', 0, 3, '10', ',11', 13, null, '阿吧', 'ABB', 'BDD', 'ACD', 'ä']
items.sort(sortPinyin)
// [ ",11", 0, "10", 13, 3, "ä", "ABB", "abc", "ACD", "BDD", null, "阿吧", "啊我", "波拉" ]
items.sort((a, b) => sortPinyin(a, b, { ignorePunctuation: true, numeric: true }))
// [ 0, 3, "10", ",11", 13, "ä", "ABB", "abc", "ACD", "BDD", null, "阿吧", "啊我", "波拉" ]
+-
+
- Types: +
declare function sortPinyin<T = string, P = string>(
a: T,
b: P,
options?: Intl.CollatorOptions
): number
+cleanData
Data cleaning methods
+-
+
-
+
Since:
+1.0.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| data | +the object to be cleaned | +object |
+- | +true |
+- | +
| map | +the data queue to be cleaned, can be passed as array or object | +array/object |
+- | +true |
+- | +
| nullFix | +the value returned if there is no corresponding property, the default does not return the property | +any |
+- | +false |
+- | +
-
+
-
+
Returns:
+any
+ -
+
Example:
+
+
//
+-
+
- Types: +
declare function cleanData(data: any, map: any[] | AnyObject, nullFix?: any): any
+download
Several ways of file downloading:
+-
+
- For file formats that some browsers do not recognize. Enter the file URL in the address bar, window.location.href = URL, window.open(URL); +
- using a tag download attribute (or js create a tag); +
- browser-recognizable pdf, txt files, back-end compatible with handling attachment; +
- add token in the header for authenticated download, use XmlHttpRequest to want to backend to launch the request +
-
+
-
+
Since:
+1.0.5
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +url link | +string |
+- | +true |
+- | +
| filename | +file name | +string |
+- | +true |
+- | +
| type | +download type | +string |
+href/open/download/request |
+false |
+download |
+
-
+
-
+
Returns:
+void
+ -
+
Example:
+
+
download('https://unpkg.com/browse/js-cool@5.2.0/dist/index.global.prod.js')
+-
+
- Types: +
declare function download(url: string, filename: string, type?: string): void
+searchObject
tree object depth lookup
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| tree | +tree object | +array/object |
+- | +true |
+- | +
| expression | +required Query method | +any |
+- | +true |
+- | +
| keySet | +optional Default subclass name, query name | +SearchKeySet |
+- | +true |
+- | +
| number | +optional Number of lookups, if not passed, query all | +number |
+- | +false |
+- | +
-
+
-
+
Returns:
+any
+ -
+
Example:
+
+
//
+-
+
- Types: +
declare function searchObject(
tree: object | any[],
expression: any,
keySet: SearchKeySet,
number?: number
): any[]
+openUrl
Open link in new tab (file jump download if browser can't parse)
+-
+
-
+
Since:
+1.0.6
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +http url | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean | undefined
+ -
+
Example:
+
+
openUrl('https://www.saqqdy.com/js-cool')
+-
+
- Types: +
declare function openUrl(url: string): void
+copy
copy to clipboard
+-
+
-
+
Since:
+5.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| value | +any value | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean | undefined
+ -
+
Example:
+
+
copy('10000')
+-
+
- Types: +
declare function copy(value: string): boolean | undefined
+toThousands
Digital thousandths division
+-
+
-
+
Since:
+3.0.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| num | +the number | +string/number |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
toThousands(10000) // '10,000'
+-
+
- Types: +
declare function toThousands(num: string | number): string
+all
return true if the provided predicate function returns true for all elements in a set, otherwise return false
+-
+
-
+
Since:
+1.0.9
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| arr | +the target array | +array |
+- | +true |
+- | +
| fn | +the judgment method | +function |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
all([4, 2, 3], x => x > 1)
// true
+-
+
- Types: +
declare const all: <T = unknown>(arr: T[], fn: AnyFunction) => boolean
+any
Returns true if the provided predicate function returns true for at least one element of a set, false otherwise
+-
+
-
+
Since:
+1.0.9
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| arr | +the target array | +array |
+- | +true |
+- | +
| fn | +the judgment method | +function |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
any([0, 1, 2, 0], x => x >= 2)
// true
+-
+
- Types: +
declare const any: <T = unknown>(arr: T[], fn: AnyFunction) => boolean
+uuid
generate uuid on browser side, use v4 method
+-
+
-
+
Since:
+1.0.9
+ -
+
Arguments:
+none
+ -
+
Returns:
+string
+ -
+
Example:
+
+
uuid() // '4222fcfe-5721-4632-bede-6043885be57d'
+-
+
- Types: +
declare const uuid: () => string
+CSVToArray
Converts a comma-separated string of values (CSV) to a 2D array.
+-
+
-
+
Since:
+1.0.9
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| data | +csv data | +string |
+- | +true |
+- | +
| delimiter | +delimiter | +string |
+- | +false |
+',' | +
| omitFirstRow | +the first row is the table header data | +boolean |
+- | +false |
+false |
+
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
CSVToArray('a,b\\nc,d') // `[['a','b'],['c','d']]`
CSVToArray('a;b\\\nc;d', ';') // `[['a','b'],['c','d']]`
CSVToArray('col1,col2\\\na,b\\\nc,d', ',', true) // `[['a','b'],['c','d']]`
+-
+
- Types: +
declare const CSVToArray: (data: string, delimiter?: string, omitFirstRow?: boolean) => string[][]
+arrayToCSV
Converts a two-dimensional array to a comma-separated string of values (CSV).
+-
+
-
+
Since:
+1.0.9
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| arr | +json data | +array |
+- | +true |
+- | +
| delimiter | +delimiter | +string |
+- | +false |
+',' | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
arrayToCSV([
['a', 'b'],
['c', 'd']
])
// '"a", "b" \n "c", "d"'
arrayToCSV(
[
['a', 'b'],
['c', 'd']
],
';'
)
// '"a"; "b"\n "c"; "d"'
arrayToCSV([
['a', '"b" great'],
['c', 3.1415]
])
// '"a", """b"" great"\n "c",3.1415'
+-
+
- Types: +
declare function arrayToCSV<T extends unknown[][]>(data: T, delimiter?: string): string
+CSVToJSON
Converts a comma-separated string of values (CSV) to an array of 2D objects. The first line of the string is used as the header line.
+-
+
-
+
Since:
+1.0.9
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| data | +csv data | +string |
+- | +true |
+- | +
| delimiter | +delimiter | +string |
+- | +false |
+',' | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
CSVToJSON('col1,col2\\na,b\\\nc,d')
// `[{'col1': 'a', 'col2': 'b'}, {'col1': 'c', 'col2': 'd'}]`
CSVToJSON('col1;col2\\\na;b\\\nc;d', ';')
// `[{'col1': 'a', 'col2': 'b'}, {'col1': 'c', 'col2': 'd'}]`
+-
+
- Types: +
declare function CSVToJSON(data: string, delimiter?: string): any[]
+JSONToCSV
Converts an array of objects to a comma-separated value (CSV) string containing only the specified columns.
+-
+
-
+
Since:
+1.0.9
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| arr | +json data | +array |
+- | +true |
+- | +
| columns | +the specified columns | +array |
+- | +true |
+- | +
| delimiter | +delimiter | +string |
+- | +false |
+',' | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
JSONToCSV([{ a: 1, b: 2 }, { a: 3, b: 4, c: 5 }, { a: 6 }, { b: 7 }], ['a', 'b']) // 'a,b\n "1", "2"\n "3", "4"\n "6",""\n"", "7"'
JSONToCSV([{ a: 1, b: 2 }, { a: 3, b: 4, c: 5 }, { a: 6 }, { b: 7 }], ['a', 'b'], ';') // 'a;b\n "1"; "2"\n "3"; "4"\n "6";""\n""; "7"'
+-
+
- Types: +
declare const JSONToCSV: (arr: any[], columns: any[], delimiter?: string) => string
+RGBToHex
Converts RGB component values to color codes.
+-
+
-
+
Since:
+1.0.9
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| r | +the 1st value of RGB | +number |
+- | +true |
+- | +
| g | +RGB's 2nd value | +number |
+- | +true |
+- | +
| b | +RGB's 3nd value | +number |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
RGBToHex(255, 165, 1) // 'ffa501'
+-
+
- Types: +
declare const RGBToHex: (r: number, g: number, b: number) => string
+intersect
Find the intersection of multiple arrays
+-
+
-
+
Since:
+2.2.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| ...arr | +array targets | +array |
+- | +true |
+- | +
-
+
-
+
Returns:
+array
+ -
+
Example:
+
+
intersect([1, 2], [2, 3, 4], [2, 8], [2, '33']) // [2]
+-
+
- Types: +
declare function intersect<T = unknown>(...args: T[][]): T[]
+union
Find the concatenation of multiple arrays
+-
+
-
+
Since:
+2.2.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| ...arr | +array targets | +array |
+- | +true |
+- | +
-
+
-
+
Returns:
+array
+ -
+
Example:
+
+
union([1, 2], [2, '33']) // [1, 2, '33']
+-
+
- Types: +
declare function union<T = unknown>(...args: T[][]): T[]
+minus
Find the set of differences of multiple arrays that belong to A but not to B/C/D... of the elements of
+-
+
-
+
Since:
+2.2.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| ...arr | +array targets | +array |
+- | +true |
+- | +
-
+
-
+
Returns:
+array
+ -
+
Example:
+
+
minus([1, 2], [2, '33'], [2, 4]) // [1]
+-
+
- Types: +
declare function minus<T = unknown>(...args: T[][]): T[]
+complement
Find the complement of multiple arrays
+-
+
-
+
Since:
+2.2.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| ...arr | +array targets | +array |
+- | +true |
+- | +
-
+
-
+
Returns:
+array
+ -
+
Example:
+
+
complement([1, 2], [2, '33'], [2]) // [1, '33']
+-
+
- Types: +
declare function complement<T = unknown>(...args: T[][]): T[]
+contains
Whether the array contains the specified element
+-
+
-
+
Since:
+2.2.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| arr | +array target | +array |
+- | +true |
+- | +
| item | +any array member | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
contains([1, 2], 2) // true
contains([1, 2], 3) // false
+-
+
- Types: +
declare function contains(arr: any[], item: any): boolean
+unique
Array de-duplication
+-
+
-
+
Since:
+2.2.1
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| arr | +array target | +array |
+- | +true |
+- | +
-
+
-
+
Returns:
+array
+ -
+
Example:
+
+
unique([1, 2, 2, '33']) // [1, 2, '33']
+-
+
- Types: +
declare function unique<T = unknown>(arr: T[]): T[]
+fillIPv6
ipv6 address completion
+-
+
-
+
Since:
+2.2.2
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| ip | +ip address | +string |
+- | +true |
+- | +
-
+
-
+
Returns:
+string
+ -
+
Example:
+
+
fillIPv6('2409:8005:800::2') // '2409:8005:0800:0000:0000:0000:0000:0002'
fillIPv6('2409:8005:800::1c') // '2409:8005:0800:0000:0000:0000:0000:001c'
+-
+
- Types: +
declare function fillIPv6(ip: string): string
+getProperty
Get array, object property values based on path string
+++v5.19.0 support defaultValue
+
-
+
-
+
Since:
+2.2.4
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +target array, object | +array/object |
+- | +true |
+- | +
| prop | +query target, can pass function | +string/function |
+- | +true |
+- | +
| defaultValue | +default value | +any |
+- | +false |
+- | +
-
+
-
+
Returns:
+any
+ -
+
Example:
+
+
const target = {
a: 1,
b: [
{
c: 2,
d: NaN
}
]
}
getProperty(target, 'a') // 1
getProperty(target, 'd', 100) // 100
getProperty(target, 'b[0].c') // 2
getProperty(target, 'b[0].d', 100) // 100
getProperty(target, () => 'a') // 1
+-
+
- Types: +
export declare function getProperty<T extends Record<string, any>>(
target: T,
prop:
| string
| {
(): string
},
defaultValue?: any
): any
export declare function getProperty<T extends Array<any>>(
target: T,
prop:
| string
| {
(): string
},
defaultValue?: any
): any
+setProperty
Set array, object property values based on path string
+-
+
-
+
Since:
+2.7.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| target | +target array, object | +array/object |
+- | +true |
+- | +
| prop | +set target, support function, 'a' | 'a[1].c' | +string/function |
+- | +true |
+- | +
| value | +value | +any |
+- | +true |
+- | +
-
+
-
+
Returns:
+any
+ -
+
Example:
+
+
const target = {
a: 1,
b: [
{
c: 2
}
]
}
setProperty(target, 'a', 2)
setProperty(target, 'b[0].c', 3)
setProperty(target, () => 'a', 100)
+-
+
- Types: +
declare function setProperty(
target: any,
prop:
| string
| {
(): string
},
value: any
): any
+loadSource
load resources dynamically, support js, images, css links, css style strings
+-
+
-
+
Since:
+2.8.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +link to the resource, type must be passed when passing in styleString | +string |
+- | +true |
+- | +
| options | +parameters: attrs, props, force | +SourceOptions |
+- | +false |
+- | +
-
+
-
+
Returns:
+boolean | imageUrl
+ -
+
Example:
+
+
loadSource('/source/url', options)
+-
+
- Types: +
import { ImageAttributes } from 'mount-image'
import { LinkAttributes } from 'mount-css'
import { ScriptAttributes } from 'mount-script'
import { StyleAttributes } from 'mount-style'
declare function loadSource(
url: string,
option: SourceFileType | SourceOptions
): Promise<boolean | string>
declare type SourceFileType = 'js' | 'img' | 'css' | 'style' | string
declare interface SourceOptions {
type: SourceFileType
attrs?: LinkAttributes | StyleAttributes | ScriptAttributes | ImageAttributes
props?: LinkAttributes | StyleAttributes | ScriptAttributes | ImageAttributes
force?: boolean
}
+mountCss
dynamically load css link resources
+-
+
-
+
Since:
+2.8.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +resource url | +string |
+- | +true |
+- | +
| options | +parameters: attrs, props, force | +CssOptions |
+- | +false |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
mountCss('/source/url', options)
+-
+
- Types: +
declare interface CssOptions {
attrs?: LinkAttributes
props?: LinkAttributes
force?: boolean
}
declare interface HTMLLinkElementEX extends HTMLLinkElement {
onreadystatechange?: any
readyState?: 'loaded' | 'complete'
}
declare type LinkAttributes = Pick<
HTMLLinkElement,
| 'as'
| 'charset'
| 'crossOrigin'
| 'disabled'
| 'href'
| 'hreflang'
| 'imageSizes'
| 'imageSrcset'
| 'integrity'
| 'media'
| 'referrerPolicy'
| 'rel'
| 'rev'
| 'target'
| 'type'
>
declare function mountCss(src: string, option?: CssOptions): Promise<boolean>
+mountImg
load image resource dynamically
+-
+
-
+
Since:
+2.8.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +resource url | +string |
+- | +true |
+- | +
| options | +parameters: attrs, props, force | +ImgOptions |
+- | +false |
+- | +
-
+
-
+
Returns:
+boolean | imageUrl
+ -
+
Example:
+
+
mountImg('/source/url', options)
+-
+
- Types: +
declare interface HTMLImageElementEX extends HTMLImageElement {
onreadystatechange?: any
readyState?: 'loaded' | 'complete'
}
declare type ImageAttributes = Pick<
HTMLImageElement,
| 'align'
| 'alt'
| 'border'
| 'crossOrigin'
| 'decoding'
| 'height'
| 'hspace'
| 'isMap'
| 'loading'
| 'longDesc'
| 'lowsrc'
| 'name'
| 'referrerPolicy'
| 'sizes'
| 'src'
| 'srcset'
| 'useMap'
| 'vspace'
| 'width'
>
declare interface ImgOptions {
attrs?: ImageAttributes
props?: ImageAttributes
force?: boolean
}
declare function mountImage(src: string, option?: ImgOptions): Promise<boolean | string>
+mountJs
load js link resources dynamically
+-
+
-
+
Since:
+2.8.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +resource url | +string |
+- | +true |
+- | +
| options | +parameters: attrs, props, force | +JsOptions |
+- | +false |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
mountJs('/source/url', options)
+-
+
- Types: +
declare interface HTMLScriptElementEX extends HTMLScriptElement {
onreadystatechange?: any
readyState?: 'loaded' | 'complete'
}
declare interface JsOptions {
attrs?: ScriptAttributes
props?: ScriptAttributes
force?: boolean
}
declare function mountJs(src: string, option?: JsOptions): Promise<boolean>
declare type ScriptAttributes = Pick<
HTMLScriptElement,
| 'async'
| 'charset'
| 'crossOrigin'
| 'defer'
| 'event'
| 'htmlFor'
| 'integrity'
| 'noModule'
| 'referrerPolicy'
| 'src'
| 'text'
| 'type'
>
+mountStyle
load css styles dynamically
+-
+
-
+
Since:
+2.8.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| url | +resource url | +string |
+- | +true |
+- | +
| options | +parameters: attrs, props, force | +StyleOptions |
+- | +false |
+- | +
-
+
-
+
Returns:
+boolean
+ -
+
Example:
+
+
mountStyle('/source/url', options)
+-
+
- Types: +
declare function mountStyle(css: string, option?: StyleOptions): Promise<boolean>
declare type StyleAttributes = Pick<HTMLStyleElement, 'disabled' | 'media' | 'type'>
declare interface StyleOptions {
attrs?: StyleAttributes
props?: StyleAttributes
}
+preloader
Image preloading
+-
+
-
+
Since:
+5.5.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| images | +images url | +string array |
+- | +true |
+- | +
-
+
-
+
Returns: void
+
+ -
+
Example:
+
+
preloader('path/of/image')
preloader(['path/of/image'])
+-
+
- Types: +
declare function preloader(images: string): HTMLImageElement
declare function preloader(images: string[]): Record<string, HTMLImageElement>
+waiting
++v5.8.1 Support throw on timeout
+
waiting for a while
+-
+
-
+
Since:
+5.5.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| milliseconds | +waiting time (milliseconds) | +number |
+- | +true |
+- | +
| throwOnTimeout | +throw on timeout | +boolean |
+- | +false |
+false |
+
-
+
-
+
Returns:
+Promise<void>
+ -
+
Example:
+
+
waiting(2000)
await waiting(2000, true)
// reject
+-
+
- Types: +
declare function waiting(milliseconds: number, throwOnTimeout?: boolean): Promise<void>
+awaitTo
Async await wrapper for easy error handling
+++v5.7.0 Extend awaitTo to support passing in multiple promises
+
-
+
-
+
Since:
+5.2.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| promise | +promise function | +Promise Promise[] |
+- | +true |
+- | +
| ...promises | +Promise rest params | +Promise[] |
+- | +false |
+- | +
-
+
-
+
Returns:
+[Error, undefined]or[null, data | data[]]
+ -
+
Example:
+
+
import { awaitTo as to } from 'js-cool'
// 1. simple use
const [err, data] = await to(new Promise())
if (err) {
// handle request error
}
// 2. Pass in multiple promises
const [err, data] = await to(promise1, promise2)
// or
const [err, data] = await to([promise1, promise2])
+-
+
- Types: +
declare function awaitTo<T, E = Error>(promise: Promise<T>): Promise<[E, undefined] | [null, T]>
declare function awaitTo<P extends readonly unknown[] | [], E = Error>(
promise: PromiseAll<P>
): Promise<[E, undefined] | [null, P]>
declare function awaitTo<T, P extends readonly unknown[] | [], E = Error>(
promise: Promise<T>,
...promises: PromiseAll<P>
): Promise<[E, undefined] | [null, [T, ...P]]>
export declare type PromiseAll<P extends readonly unknown[] | []> = {
-readonly [K in keyof P]: Promise<P[K]>
}
+Blob arrayBuffer base64 file blobUrl
arrayBufferToBase64
arrayBuffer to base64
+++v5.19.1 remove default params of mime
+
-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +arrayBuffer data | +ArrayBuffer |
+- | +true |
+- | +
| mime | +image mime | +String |
+- | +false |
+- | +
-
+
-
+
Returns:
+String
+ -
+
Example:
+
+
arrayBufferToBase64(arrayBuffer, 'image/png')
// data:image/png;base64,xxxxxxxxxxxx
arrayBufferToBase64(arrayBuffer)
// xxxxxxxxxxxx
+-
+
- Types: +
declare function arrayBufferToBase64(input: ArrayBuffer, mime?: string): string
+arrayBufferToBlob
arrayBuffer to blob
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +arrayBuffer data | +ArrayBuffer |
+- | +true |
+- | +
| mime | +image mime | +String |
+- | +false |
+image/png |
+
-
+
-
+
Returns:
+Blob
+ -
+
Example:
+
+
arrayBufferToBlob(arrayBuffer, 'image/png')
// Blob
+-
+
- Types: +
declare function arrayBufferToBlob(input: ArrayBuffer, mime?: string): Blob
+base64ToArrayBuffer
base64 to arrayBuffer
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +base64 string | +String |
+- | +true |
+- | +
-
+
-
+
Returns:
+ArrayBuffer
+ -
+
Example:
+
+
base64ToArrayBuffer(base64)
// ArrayBuffer
+-
+
- Types: +
declare function base64ToArrayBuffer(input: string): ArrayBuffer
+base64ToBlob
base64 to blob
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +base64 string | +String |
+- | +true |
+- | +
-
+
-
+
Returns:
+Blob
+ -
+
Example:
+
+
base64ToBlob(base64)
// Blob
+-
+
- Types: +
declare function base64ToBlob(input: string): Blob
+base64ToFile
base64 to file
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +base64 string | +String |
+- | +true |
+- | +
| fileName | +file name | +String |
+- | +true |
+- | +
-
+
-
+
Returns:
+File
+ -
+
Example:
+
+
base64ToFile(base64, 'image.png')
// File
+-
+
- Types: +
declare function base64ToFile(input: string, fileName: string): File
+blobToArrayBuffer
blob to arrayBuffer
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +blob data | +Blob |
+- | +true |
+- | +
-
+
-
+
Returns:
+ArrayBuffer
+ -
+
Example:
+
+
blobToArrayBuffer(blob).then(data => {
// ArrayBuffer
})
+-
+
- Types: +
declare function blobToArrayBuffer(input: Blob): Promise<ArrayBuffer | null>
+blobToBase64
blob to base64
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +blob data | +Blob |
+- | +true |
+- | +
-
+
-
+
Returns:
+String
+ -
+
Example:
+
+
blobToBase64(blob).then(data => {
// data:image/png;base64,xxxxxxxxxxxx
})
+-
+
- Types: +
declare function blobToBase64(input: Blob): Promise<string | null>
+blobToUrl
blob to url
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +blob data | +Blob |
+- | +true |
+- | +
-
+
-
+
Returns:
+Object
+ -
+
Example:
+
+
blobToUrl(blob)
// blob:xxxxxxx
+-
+
- Types: +
declare function blobToUrl(input: Blob): string
+fileToBase64
file to base64
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +file data | +File |
+- | +true |
+- | +
-
+
-
+
Returns:
+String
+ -
+
Example:
+
+
fileToBase64(file).then(data => {
// data:image/png;base64,xxxxxxxxxxxx
})
+-
+
- Types: +
declare function fileToBase64(input: File): Promise<string | null>
+svgToBlob
svg to blob
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +svg string | +String |
+- | +true |
+- | +
-
+
-
+
Returns:
+Blob
+ -
+
Example:
+
+
svgToBlob(svg)
// Blob
+-
+
- Types: +
declare function svgToBlob(input: string): Blob
+urlToBlob
url to blob
+-
+
-
+
Since:
+5.13.0
+ -
+
Arguments:
+
+
| Parameters | +Description | +Type | +Optional | +Required | +Default | +
|---|---|---|---|---|---|
| input | +url | +String |
+- | +true |
+- | +
-
+
-
+
Returns:
+Blob
+ -
+
Example:
+
+
urlToBlob(url).then(blob => {
// Blob
})
+-
+
- Types: +
declare function urlToBlob(input: string): Promise<Blob | null>
+Support & Issues
Please open an issue here.
+License
+
diff --git a/interfaces/ArrayOne.html b/interfaces/ArrayOne.html
new file mode 100644
index 0000000..af1bc37
--- /dev/null
+++ b/interfaces/ArrayOne.html
@@ -0,0 +1,2 @@
+
diff --git a/interfaces/BrowserVersion.html b/interfaces/BrowserVersion.html
new file mode 100644
index 0000000..745bae2
--- /dev/null
+++ b/interfaces/BrowserVersion.html
@@ -0,0 +1,3 @@
+
Interface BrowserVersion
interface BrowserVersion {
name:
| "Safari"
| "Chrome"
| "IE"
| "Edge"
| "Firefox"
| "Firefox Focus"
| "Chromium"
| "Opera"
| "Vivaldi"
| "Yandex"
| "Arora"
| "Lunascape"
| "QupZilla"
| "Coc Coc"
| "Kindle"
| "Iceweasel"
| "Konqueror"
| "Iceape"
| "SeaMonkey"
| "Epiphany"
| "360"
| "360SE"
| "360EE"
| "Maxthon"
| "QQBrowser"
| "QQ"
| "Baidu"
| "UC"
| "Sogou"
| "Liebao"
| "LBBROWSER"
| "2345Explorer"
| "115Browser"
| "TheWorld"
| "XiaoMi"
| "Vivo"
| "Quark"
| "Qiyu"
| "Wechat"
| "WechatWork"
| "Taobao"
| "Alipay"
| "Weibo"
| "Douban"
| "Suning"
| "iQiYi"
| "DingTalk"
| "Huawei";
version: string;
}
name:
| "Safari"
| "Chrome"
| "IE"
| "Edge"
| "Firefox"
| "Firefox Focus"
| "Chromium"
| "Opera"
| "Vivaldi"
| "Yandex"
| "Arora"
| "Lunascape"
| "QupZilla"
| "Coc Coc"
| "Kindle"
| "Iceweasel"
| "Konqueror"
| "Iceape"
| "SeaMonkey"
| "Epiphany"
| "360"
| "360SE"
| "360EE"
| "Maxthon"
| "QQBrowser"
| "QQ"
| "Baidu"
| "UC"
| "Sogou"
| "Liebao"
| "LBBROWSER"
| "2345Explorer"
| "115Browser"
| "TheWorld"
| "XiaoMi"
| "Vivo"
| "Quark"
| "Qiyu"
| "Wechat"
| "WechatWork"
| "Taobao"
| "Alipay"
| "Weibo"
| "Douban"
| "Suning"
| "iQiYi"
| "DingTalk"
| "Huawei";
version: string;
}
Properties
name
name:
| "Safari"
| "Chrome"
| "IE"
| "Edge"
| "Firefox"
| "Firefox Focus"
| "Chromium"
| "Opera"
| "Vivaldi"
| "Yandex"
| "Arora"
| "Lunascape"
| "QupZilla"
| "Coc Coc"
| "Kindle"
| "Iceweasel"
| "Konqueror"
| "Iceape"
| "SeaMonkey"
| "Epiphany"
| "360"
| "360SE"
| "360EE"
| "Maxthon"
| "QQBrowser"
| "QQ"
| "Baidu"
| "UC"
| "Sogou"
| "Liebao"
| "LBBROWSER"
| "2345Explorer"
| "115Browser"
| "TheWorld"
| "XiaoMi"
| "Vivo"
| "Quark"
| "Qiyu"
| "Wechat"
| "WechatWork"
| "Taobao"
| "Alipay"
| "Weibo"
| "Douban"
| "Suning"
| "iQiYi"
| "DingTalk"
| "Huawei"
| "Safari"
| "Chrome"
| "IE"
| "Edge"
| "Firefox"
| "Firefox Focus"
| "Chromium"
| "Opera"
| "Vivaldi"
| "Yandex"
| "Arora"
| "Lunascape"
| "QupZilla"
| "Coc Coc"
| "Kindle"
| "Iceweasel"
| "Konqueror"
| "Iceape"
| "SeaMonkey"
| "Epiphany"
| "360"
| "360SE"
| "360EE"
| "Maxthon"
| "QQBrowser"
| "QQ"
| "Baidu"
| "UC"
| "Sogou"
| "Liebao"
| "LBBROWSER"
| "2345Explorer"
| "115Browser"
| "TheWorld"
| "XiaoMi"
| "Vivo"
| "Quark"
| "Qiyu"
| "Wechat"
| "WechatWork"
| "Taobao"
| "Alipay"
| "Weibo"
| "Douban"
| "Suning"
| "iQiYi"
| "DingTalk"
| "Huawei"
version
version: string
diff --git a/interfaces/JSONArray.html b/interfaces/JSONArray.html
new file mode 100644
index 0000000..a93c536
--- /dev/null
+++ b/interfaces/JSONArray.html
@@ -0,0 +1,222 @@
+
Interface JSONArray
interface JSONArray {
find<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => value is S,
thisArg?: any,
): undefined | S;
find(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue;
findIndex(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => unknown,
thisArg?: any,
): number;
fill(value: JSONValue, start?: number, end?: number): this;
copyWithin(target: number, start: number, end?: number): this;
"[iterator]"(): ArrayIterator<JSONValue>;
entries(): ArrayIterator<[number, JSONValue]>;
keys(): ArrayIterator<number>;
values(): ArrayIterator<JSONValue>;
"[unscopables]": {
find?: any;
findIndex?: any;
fill?: any;
copyWithin?: any;
"[iterator]"?: any;
entries?: any;
keys?: any;
values?: any;
"[unscopables]"?: boolean;
includes?: any;
flatMap?: any;
flat?: any;
at?: any;
findLast?: any;
findLastIndex?: any;
toReversed?: any;
toSorted?: any;
toSpliced?: any;
with?: any;
length?: boolean;
toString?: any;
toLocaleString?: any;
pop?: any;
push?: any;
concat?: any;
join?: any;
reverse?: any;
shift?: any;
slice?: any;
sort?: any;
splice?: any;
unshift?: any;
indexOf?: any;
lastIndexOf?: any;
every?: any;
some?: any;
forEach?: any;
map?: any;
filter?: any;
reduce?: any;
reduceRight?: any;
[key: number]: undefined | boolean;
};
includes(searchElement: JSONValue, fromIndex?: number): boolean;
flatMap<U, This = undefined>(
callback: (
this: This,
value: JSONValue,
index: number,
array: JSONValue[],
) => U | readonly U[],
thisArg?: This,
): U[];
flat<A, D extends number = 1>(this: A, depth?: D): FlatArray<A, D>[];
at(index: number): JSONValue;
findLast<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): undefined | S;
findLast(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue;
findLastIndex(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): number;
toReversed(): JSONValue[];
toSorted(compareFn?: (a: JSONValue, b: JSONValue) => number): JSONValue[];
toSpliced(
start: number,
deleteCount: number,
...items: JSONValue[],
): JSONValue[];
toSpliced(start: number, deleteCount?: number): JSONValue[];
with(index: number, value: JSONValue): JSONValue[];
length: number;
toString(): string;
toLocaleString(): string;
toLocaleString(
locales: string | string[],
options?: NumberFormatOptions & DateTimeFormatOptions,
): string;
pop(): JSONValue;
push(...items: JSONValue[]): number;
concat(...items: ConcatArray<JSONValue>[]): JSONValue[];
concat(...items: (JSONValue | ConcatArray<JSONValue>)[]): JSONValue[];
join(separator?: string): string;
reverse(): JSONValue[];
shift(): JSONValue;
slice(start?: number, end?: number): JSONValue[];
sort(compareFn?: (a: JSONValue, b: JSONValue) => number): this;
splice(start: number, deleteCount?: number): JSONValue[];
splice(
start: number,
deleteCount: number,
...items: JSONValue[],
): JSONValue[];
unshift(...items: JSONValue[]): number;
indexOf(searchElement: JSONValue, fromIndex?: number): number;
lastIndexOf(searchElement: JSONValue, fromIndex?: number): number;
every<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): this is S[];
every(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): boolean;
some(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): boolean;
forEach(
callbackfn: (
value: JSONValue,
index: number,
array: JSONValue[],
) => void,
thisArg?: any,
): void;
map<U>(
callbackfn: (value: JSONValue, index: number, array: JSONValue[]) => U,
thisArg?: any,
): U[];
filter<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): S[];
filter(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue[];
reduce(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
): JSONValue;
reduce(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
initialValue: JSONValue,
): JSONValue;
reduce<U>(
callbackfn: (
previousValue: U,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => U,
initialValue: U,
): U;
reduceRight(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
): JSONValue;
reduceRight(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
initialValue: JSONValue,
): JSONValue;
reduceRight<U>(
callbackfn: (
previousValue: U,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => U,
initialValue: U,
): U;
[n: number]: JSONValue;
}
find<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => value is S,
thisArg?: any,
): undefined | S;
find(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue;
findIndex(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => unknown,
thisArg?: any,
): number;
fill(value: JSONValue, start?: number, end?: number): this;
copyWithin(target: number, start: number, end?: number): this;
"[iterator]"(): ArrayIterator<JSONValue>;
entries(): ArrayIterator<[number, JSONValue]>;
keys(): ArrayIterator<number>;
values(): ArrayIterator<JSONValue>;
"[unscopables]": {
find?: any;
findIndex?: any;
fill?: any;
copyWithin?: any;
"[iterator]"?: any;
entries?: any;
keys?: any;
values?: any;
"[unscopables]"?: boolean;
includes?: any;
flatMap?: any;
flat?: any;
at?: any;
findLast?: any;
findLastIndex?: any;
toReversed?: any;
toSorted?: any;
toSpliced?: any;
with?: any;
length?: boolean;
toString?: any;
toLocaleString?: any;
pop?: any;
push?: any;
concat?: any;
join?: any;
reverse?: any;
shift?: any;
slice?: any;
sort?: any;
splice?: any;
unshift?: any;
indexOf?: any;
lastIndexOf?: any;
every?: any;
some?: any;
forEach?: any;
map?: any;
filter?: any;
reduce?: any;
reduceRight?: any;
[key: number]: undefined | boolean;
};
includes(searchElement: JSONValue, fromIndex?: number): boolean;
flatMap<U, This = undefined>(
callback: (
this: This,
value: JSONValue,
index: number,
array: JSONValue[],
) => U | readonly U[],
thisArg?: This,
): U[];
flat<A, D extends number = 1>(this: A, depth?: D): FlatArray<A, D>[];
at(index: number): JSONValue;
findLast<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): undefined | S;
findLast(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue;
findLastIndex(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): number;
toReversed(): JSONValue[];
toSorted(compareFn?: (a: JSONValue, b: JSONValue) => number): JSONValue[];
toSpliced(
start: number,
deleteCount: number,
...items: JSONValue[],
): JSONValue[];
toSpliced(start: number, deleteCount?: number): JSONValue[];
with(index: number, value: JSONValue): JSONValue[];
length: number;
toString(): string;
toLocaleString(): string;
toLocaleString(
locales: string | string[],
options?: NumberFormatOptions & DateTimeFormatOptions,
): string;
pop(): JSONValue;
push(...items: JSONValue[]): number;
concat(...items: ConcatArray<JSONValue>[]): JSONValue[];
concat(...items: (JSONValue | ConcatArray<JSONValue>)[]): JSONValue[];
join(separator?: string): string;
reverse(): JSONValue[];
shift(): JSONValue;
slice(start?: number, end?: number): JSONValue[];
sort(compareFn?: (a: JSONValue, b: JSONValue) => number): this;
splice(start: number, deleteCount?: number): JSONValue[];
splice(
start: number,
deleteCount: number,
...items: JSONValue[],
): JSONValue[];
unshift(...items: JSONValue[]): number;
indexOf(searchElement: JSONValue, fromIndex?: number): number;
lastIndexOf(searchElement: JSONValue, fromIndex?: number): number;
every<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): this is S[];
every(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): boolean;
some(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): boolean;
forEach(
callbackfn: (
value: JSONValue,
index: number,
array: JSONValue[],
) => void,
thisArg?: any,
): void;
map<U>(
callbackfn: (value: JSONValue, index: number, array: JSONValue[]) => U,
thisArg?: any,
): U[];
filter<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): S[];
filter(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue[];
reduce(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
): JSONValue;
reduce(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
initialValue: JSONValue,
): JSONValue;
reduce<U>(
callbackfn: (
previousValue: U,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => U,
initialValue: U,
): U;
reduceRight(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
): JSONValue;
reduceRight(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
initialValue: JSONValue,
): JSONValue;
reduceRight<U>(
callbackfn: (
previousValue: U,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => U,
initialValue: U,
): U;
[n: number]: JSONValue;
}
Hierarchy
- Array<JSONValue>
- JSONArray
Indexable
Index
Properties
Methods
find
+find
Properties
Readonly[unscopables]
"[unscopables]": {
find?: any;
findIndex?: any;
fill?: any;
copyWithin?: any;
"[iterator]"?: any;
entries?: any;
keys?: any;
values?: any;
"[unscopables]"?: boolean;
includes?: any;
flatMap?: any;
flat?: any;
at?: any;
findLast?: any;
findLastIndex?: any;
toReversed?: any;
toSorted?: any;
toSpliced?: any;
with?: any;
length?: boolean;
toString?: any;
toLocaleString?: any;
pop?: any;
push?: any;
concat?: any;
join?: any;
reverse?: any;
shift?: any;
slice?: any;
sort?: any;
splice?: any;
unshift?: any;
indexOf?: any;
lastIndexOf?: any;
every?: any;
some?: any;
forEach?: any;
map?: any;
filter?: any;
reduce?: any;
reduceRight?: any;
[key: number]: undefined | boolean;
}
find?: any;
findIndex?: any;
fill?: any;
copyWithin?: any;
"[iterator]"?: any;
entries?: any;
keys?: any;
values?: any;
"[unscopables]"?: boolean;
includes?: any;
flatMap?: any;
flat?: any;
at?: any;
findLast?: any;
findLastIndex?: any;
toReversed?: any;
toSorted?: any;
toSpliced?: any;
with?: any;
length?: boolean;
toString?: any;
toLocaleString?: any;
pop?: any;
push?: any;
concat?: any;
join?: any;
reverse?: any;
shift?: any;
slice?: any;
sort?: any;
splice?: any;
unshift?: any;
indexOf?: any;
lastIndexOf?: any;
every?: any;
some?: any;
forEach?: any;
map?: any;
filter?: any;
reduce?: any;
reduceRight?: any;
[key: number]: undefined | boolean;
}
Is an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement.
+Type declaration
[key: number]: undefined | boolean
OptionalReadonly[unscopables]?: booleanIs an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement.
+Optionallength?: booleanGets or sets the length of the array. This is a number one higher than the highest index in the array.
+
length
length: number
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
+ Methods
find
- find<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => value is S,
thisArg?: any,
): undefined | S Returns the value of the first element in the array where predicate is true, and undefined +otherwise.
+Type Parameters
- S extends JSONValue
Parameters
- predicate: (value: JSONValue, index: number, obj: JSONValue[]) => value is S
find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined.
+ OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.
+
Returns undefined | S
- find(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue Parameters
Returns JSONValue
find
- findIndex(
predicate: (
value: JSONValue,
index: number,
obj: JSONValue[],
) => unknown,
thisArg?: any,
): number Returns the index of the first element in the array where predicate is true, and -1 +otherwise.
+Parameters
- predicate: (value: JSONValue, index: number, obj: JSONValue[]) => unknown
find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1.
+ OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.
+
Returns number
- predicate: (value: JSONValue, index: number, obj: JSONValue[]) => unknown
fill
- fill(value: JSONValue, start?: number, end?: number): this
Changes all array elements from
+starttoendindex to a staticvalueand returns the modified arrayParameters
- value: JSONValue
value to fill array section with
+ Optionalstart: numberindex to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array.
+Optionalend: numberindex to stop filling the array at. If end is negative, it is treated as +length+end.
+
Returns this
- value: JSONValue
copy
- copyWithin(target: number, start: number, end?: number): this
Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target
+Parameters
- target: number
If target is negative, it is treated as length+target where length is the +length of the array.
+ - start: number
If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end.
+ Optionalend: numberIf not specified, length of the this object is used as its default value.
+
Returns this
- target: number
[iterator]
entries
keys
values
includes
- includes(searchElement: JSONValue, fromIndex?: number): boolean
Determines whether an array includes a certain element, returning true or false as appropriate.
+Parameters
- searchElement: JSONValue
The element to search for.
+ OptionalfromIndex: numberThe position in this array at which to begin searching for searchElement.
+
Returns boolean
- searchElement: JSONValue
flat
- flatMap<U, This = undefined>(
callback: (
this: This,
value: JSONValue,
index: number,
array: JSONValue[],
) => U | readonly U[],
thisArg?: This,
): U[] Calls a defined callback function on each element of an array. Then, flattens the result into +a new array. +This is identical to a map followed by flat with depth 1.
+Type Parameters
Parameters
- callback: (
this: This,
value: JSONValue,
index: number,
array: JSONValue[],
) => U | readonly U[]A function that accepts up to three arguments. The flatMap method calls the +callback function one time for each element in the array.
+ OptionalthisArg: ThisAn object to which the this keyword can refer in the callback function. If +thisArg is omitted, undefined is used as the this value.
+
Returns U[]
- callback: (
flat
at
find
- findLast<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): undefined | S Returns the value of the last element in the array where predicate is true, and undefined +otherwise.
+Type Parameters
- S extends JSONValue
Parameters
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => value is S
findLast calls predicate once for each element of the array, in descending +order, until it finds one where predicate returns true. If such an element is found, findLast +immediately returns that element value. Otherwise, findLast returns undefined.
+ OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.
+
Returns undefined | S
- findLast(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue Parameters
Returns JSONValue
find
- findLastIndex(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): number Returns the index of the last element in the array where predicate is true, and -1 +otherwise.
+Parameters
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => unknown
findLastIndex calls predicate once for each element of the array, in descending +order, until it finds one where predicate returns true. If such an element is found, +findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.
+ OptionalthisArg: anyIf provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead.
+
Returns number
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => unknown
to
to
- toSorted(compareFn?: (a: JSONValue, b: JSONValue) => number): JSONValue[]
Returns a copy of an array with its elements sorted.
+Parameters
OptionalcompareFn: (a: JSONValue, b: JSONValue) => numberFunction used to determine the order of the elements. It is expected to return +a negative value if the first argument is less than the second argument, zero if they're equal, and a positive +value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
+
+ +[11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22] +
Returns JSONValue[]
to
- toSpliced(
start: number,
deleteCount: number,
...items: JSONValue[],
): JSONValue[] Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.
+Parameters
- start: number
The zero-based location in the array from which to start removing elements.
+ - deleteCount: number
The number of elements to remove.
+ - ...items: JSONValue[]
Elements to insert into the copied array in place of the deleted elements.
+
Returns JSONValue[]
The copied array.
+- start: number
- toSpliced(start: number, deleteCount?: number): JSONValue[]
Copies an array and removes elements while returning the remaining elements.
+Parameters
- start: number
The zero-based location in the array from which to start removing elements.
+ OptionaldeleteCount: numberThe number of elements to remove.
+
Returns JSONValue[]
A copy of the original array with the remaining elements.
+- start: number
with
- with(index: number, value: JSONValue): JSONValue[]
Copies an array, then overwrites the value at the provided index with the +given value. If the index is negative, then it replaces from the end +of the array.
+Parameters
- index: number
The index of the value to overwrite. If the index is +negative, then it replaces from the end of the array.
+ - value: JSONValue
The value to write into the copied array.
+
Returns JSONValue[]
The copied array with the updated value.
+- index: number
to
to
- toLocaleString(): string
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
+Returns string
- toLocaleString(
locales: string | string[],
options?: NumberFormatOptions & DateTimeFormatOptions,
): string Parameters
- locales: string | string[]
Optionaloptions: NumberFormatOptions & DateTimeFormatOptions
Returns string
pop
push
concat
- concat(...items: ConcatArray<JSONValue>[]): JSONValue[]
Combines two or more arrays. +This method returns a new array without modifying any existing arrays.
+Parameters
- ...items: ConcatArray<JSONValue>[]
Additional arrays and/or items to add to the end of the array.
+
Returns JSONValue[]
- ...items: ConcatArray<JSONValue>[]
- concat(...items: (JSONValue | ConcatArray<JSONValue>)[]): JSONValue[]
Combines two or more arrays. +This method returns a new array without modifying any existing arrays.
+Parameters
Returns JSONValue[]
join
- join(separator?: string): string
Adds all the elements of an array into a string, separated by the specified separator string.
+Parameters
Optionalseparator: stringA string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
+
Returns string
reverse
shift
slice
- slice(start?: number, end?: number): JSONValue[]
Returns a copy of a section of an array. +For both start and end, a negative index can be used to indicate an offset from the end of the array. +For example, -2 refers to the second to last element of the array.
+Parameters
Optionalstart: numberThe beginning index of the specified portion of the array. +If start is undefined, then the slice begins at index 0.
+Optionalend: numberThe end index of the specified portion of the array. This is exclusive of the element at the index 'end'. +If end is undefined, then the slice extends to the end of the array.
+
Returns JSONValue[]
sort
- sort(compareFn?: (a: JSONValue, b: JSONValue) => number): this
Sorts an array in place. +This method mutates the array and returns a reference to the same array.
+Parameters
OptionalcompareFn: (a: JSONValue, b: JSONValue) => numberFunction used to determine the order of the elements. It is expected to return +a negative value if the first argument is less than the second argument, zero if they're equal, and a positive +value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
+
+ +[11,2,22,1].sort((a, b) => a - b) +
Returns this
splice
- splice(start: number, deleteCount?: number): JSONValue[]
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
+Parameters
- start: number
The zero-based location in the array from which to start removing elements.
+ OptionaldeleteCount: numberThe number of elements to remove.
+
Returns JSONValue[]
An array containing the elements that were deleted.
+- start: number
- splice(start: number, deleteCount: number, ...items: JSONValue[]): JSONValue[]
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
+Parameters
- start: number
The zero-based location in the array from which to start removing elements.
+ - deleteCount: number
The number of elements to remove.
+ - ...items: JSONValue[]
Elements to insert into the array in place of the deleted elements.
+
Returns JSONValue[]
An array containing the elements that were deleted.
+- start: number
unshift
index
- indexOf(searchElement: JSONValue, fromIndex?: number): number
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
+Parameters
- searchElement: JSONValue
The value to locate in the array.
+ OptionalfromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
+
Returns number
- searchElement: JSONValue
last
- lastIndexOf(searchElement: JSONValue, fromIndex?: number): number
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
+Parameters
- searchElement: JSONValue
The value to locate in the array.
+ OptionalfromIndex: numberThe array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
+
Returns number
- searchElement: JSONValue
every
- every<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): this is S[] Determines whether all the members of an array satisfy the specified test.
+Type Parameters
- S extends JSONValue
Parameters
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => value is S
A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.
+ OptionalthisArg: anyAn object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.
+
Returns this is S[]
- every(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): boolean Determines whether all the members of an array satisfy the specified test.
+Parameters
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => unknown
A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array.
+ OptionalthisArg: anyAn object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.
+
Returns boolean
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => unknown
some
- some(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): boolean Determines whether the specified callback function returns true for any element of an array.
+Parameters
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => unknown
A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array.
+ OptionalthisArg: anyAn object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value.
+
Returns boolean
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => unknown
for
- forEach(
callbackfn: (
value: JSONValue,
index: number,
array: JSONValue[],
) => void,
thisArg?: any,
): void Performs the specified action for each element in an array.
+Parameters
- callbackfn: (value: JSONValue, index: number, array: JSONValue[]) => void
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
+ OptionalthisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+
Returns void
- callbackfn: (value: JSONValue, index: number, array: JSONValue[]) => void
map
- map<U>(
callbackfn: (value: JSONValue, index: number, array: JSONValue[]) => U,
thisArg?: any,
): U[] Calls a defined callback function on each element of an array, and returns an array that contains the results.
+Type Parameters
Parameters
- callbackfn: (value: JSONValue, index: number, array: JSONValue[]) => U
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
+ OptionalthisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+
Returns U[]
- callbackfn: (value: JSONValue, index: number, array: JSONValue[]) => U
filter
- filter<S extends JSONValue>(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => value is S,
thisArg?: any,
): S[] Returns the elements of an array that meet the condition specified in a callback function.
+Type Parameters
- S extends JSONValue
Parameters
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => value is S
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+ OptionalthisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+
Returns S[]
- filter(
predicate: (
value: JSONValue,
index: number,
array: JSONValue[],
) => unknown,
thisArg?: any,
): JSONValue[] Returns the elements of an array that meet the condition specified in a callback function.
+Parameters
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => unknown
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+ OptionalthisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+
Returns JSONValue[]
- predicate: (value: JSONValue, index: number, array: JSONValue[]) => unknown
reduce
- reduce(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
): JSONValue Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+Parameters
Returns JSONValue
- reduce(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
initialValue: JSONValue,
): JSONValue Parameters
Returns JSONValue
- reduce<U>(
callbackfn: (
previousValue: U,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => U,
initialValue: U,
): U Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+Type Parameters
Parameters
- callbackfn: (
previousValue: U,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => UA function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+ - initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+
Returns U
- callbackfn: (
reduce
- reduceRight(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
): JSONValue Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+Parameters
Returns JSONValue
- reduceRight(
callbackfn: (
previousValue: JSONValue,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => JSONValue,
initialValue: JSONValue,
): JSONValue Parameters
Returns JSONValue
- reduceRight<U>(
callbackfn: (
previousValue: U,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => U,
initialValue: U,
): U Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+Type Parameters
Parameters
- callbackfn: (
previousValue: U,
currentValue: JSONValue,
currentIndex: number,
array: JSONValue[],
) => UA function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
+ - initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+
Returns U
- callbackfn: (
diff --git a/interfaces/PlainObject.html b/interfaces/PlainObject.html
new file mode 100644
index 0000000..bdf49de
--- /dev/null
+++ b/interfaces/PlainObject.html
@@ -0,0 +1 @@
+
Interface PlainObject
Indexable
diff --git a/interfaces/RandomStringOptions.html b/interfaces/RandomStringOptions.html
new file mode 100644
index 0000000..90c3f02
--- /dev/null
+++ b/interfaces/RandomStringOptions.html
@@ -0,0 +1,7 @@
+
Interface RandomStringOptions
interface RandomStringOptions {
length?: number;
charTypes?: RandomStringCharType | ArrayOneMore<RandomStringCharType>;
noConfuse?: boolean;
strict?: boolean;
}
length?: number;
charTypes?: RandomStringCharType | ArrayOneMore<RandomStringCharType>;
noConfuse?: boolean;
strict?: boolean;
}
Index
Properties
diff --git a/interfaces/SpliceUrlParamOptions.html b/interfaces/SpliceUrlParamOptions.html
new file mode 100644
index 0000000..d1612cf
--- /dev/null
+++ b/interfaces/SpliceUrlParamOptions.html
@@ -0,0 +1,4 @@
+
Interface SpliceUrlParamOptions
Index
Properties
diff --git a/interfaces/WindowSizeObj.html b/interfaces/WindowSizeObj.html
new file mode 100644
index 0000000..17e653c
--- /dev/null
+++ b/interfaces/WindowSizeObj.html
@@ -0,0 +1,3 @@
+
diff --git a/media/CHANGELOG.md b/media/CHANGELOG.md
new file mode 100644
index 0000000..0b2c2ba
--- /dev/null
+++ b/media/CHANGELOG.md
@@ -0,0 +1,407 @@
+# Change logs
+
+## 2025.01.17 v5.23.1
+
+1. docs work
+2. upgrade all packages
+
+## 2024.11.18 v5.23.0
+
+1. `punctualTimer` got returns of PunctualTimerReturns
+
+## 2024.11.15 v5.22.1
+
+1. fix bugs of `nextVersion`
+
+## 2024.10.16 v5.22.0
+
+1. new `isNumberBrowser` function, see: [isNumberBrowser](https://github.com/saqqdy/js-cool#isnumberbrowser)
+2. Default value of agent string for `getOsVersion` and `getAppVersion` changed to navigator.appVersion.
+
+## 2024.08.27 v5.21.2
+
+1. `pattern` support mac/ip4/ip4_pri
+
+## 2024.08.12 v5.21.1
+
+1. `osVersion` support Harmony
+
+## 2024.08.09 v5.21.0
+
+1. `spliceUrlParam` Breaking change: SpliceUrlParamOptions
+
+## 2024.08.09 v5.20.0
+
+1. `spliceUrlParam` Breaking change: remove encodeURIComponent
+
+## 2024.05.30 v5.19.2
+
+1. upgrade `await-to-done`, fix types
+
+## 2024.04.29 v5.19.1
+
+1. remove default params of `arrayBufferToBase64`
+
+## 2024.04.27 v5.19.0
+
+1. `getProperty` support defaultValue
+2. fix types
+3. upgrade all packages
+
+## 2024.03.11 v5.18.1
+
+1. fix types
+2. fix export error
+
+## 2024.03.07 v5.18.0
+
+1. new `punctualTimer` function, see: [punctualTimer](https://github.com/saqqdy/js-cool#punctualtimer)
+
+## 2024.01.21 v5.17.1
+
+1. `safeParse` `safeStringify` supports converting bigint
+
+## 2024.01.22 v5.17.0
+
+1. `randomColor` supports a range of custom color values, which can be used to customize the generation of dark, light, warm, etc.
+
+## 2024.01.21 v5.16.0
+
+1. new `safeParse` `safeStringify` function
+2. upgrade all packages
+
+## 2023.11.13 v5.15.2
+
+1. move `awaitTo` to `await-to-done` function, see: [await-to-done](https://github.com/saqqdy/await-to-done)
+2. fix circle require
+
+## 2023.11.06 v5.15.0
+
+1. new `clone` function, see: [clone](https://github.com/saqqdy/js-cool#clone)
+2. new `isDate` function, see: [isDate](https://github.com/saqqdy/js-cool#isdate)
+3. new `isRegExp` function, see: [isRegExp](https://github.com/saqqdy/js-cool#isregexp)
+
+## 2023.11.01 v5.14.1
+
+1. docs work
+
+## 2023.10.31 v5.14.0
+
+1. new `sorter` function, see: [sorter](https://github.com/saqqdy/js-cool#sorter)
+2. new `sortPinyin` function, see: [sortPinyin](https://github.com/saqqdy/js-cool#sortpinyin)
+3. upgrade all packages
+
+## 2023.10.27 v5.13.0
+
+1. new `arrayBufferToBase64` function, see: [arrayBufferToBase64](https://github.com/saqqdy/js-cool#arraybuffertobase64)
+2. new `arrayBufferToBlob` function, see: [arrayBufferToBlob](https://github.com/saqqdy/js-cool#arraybuffertoblob)
+3. new `base64ToArrayBuffer` function, see: [base64ToArrayBuffer](https://github.com/saqqdy/js-cool#base64toarraybuffer)
+4. new `base64ToBlob` function, see: [base64ToBlob](https://github.com/saqqdy/js-cool#base64toblob)
+5. new `base64ToFile` function, see: [base64ToFile](https://github.com/saqqdy/js-cool#base64tofile)
+6. new `blobToArrayBuffer` function, see: [blobToArrayBuffer](https://github.com/saqqdy/js-cool#blobtoarraybuffer)
+7. new `blobToBase64` function, see: [blobToBase64](https://github.com/saqqdy/js-cool#blobtobase64)
+8. new `blobToUrl` function, see: [blobToUrl](https://github.com/saqqdy/js-cool#blobtourl)
+9. new `fileToBase64` function, see: [fileToBase64](https://github.com/saqqdy/js-cool#filetobase64)
+10. new `svgToBlob` function, see: [svgToBlob](https://github.com/saqqdy/js-cool#svgtoblob)
+11. new `urlToBlob` function, see: [urlToBlob](https://github.com/saqqdy/js-cool#urltoblob)
+12. new `inNodeJs` function, see: [inNodeJs](https://github.com/saqqdy/js-cool#innodejs)
+
+## 2023.10.09 v5.12.0
+
+1. new `isEqual` function, see: [isEqual](https://github.com/saqqdy/js-cool#isequal)
+2. upgrade all packages
+
+## 2023.10.09 v5.11.0
+
+1. new `getFileType` function, see: [getFileType](https://github.com/saqqdy/js-cool#getfiletype)
+2. upgrade all packages
+
+## 2023.09.23 v5.10.0
+
+1. new `nextVersion` function, see: [nextVersion](https://github.com/saqqdy/js-cool#nextversion)
+2. new `promiseFactory` function, see: [promiseFactory](https://github.com/saqqdy/js-cool#promiseFactory)
+
+## 2023.09.20 v5.9.0
+
+1. new `mapTemplate` function, see: [mapTemplate](https://github.com/saqqdy/js-cool#maptemplate)
+
+## 2023.09.16 v5.8.1
+
+1. `waiting` support throw on timeout [API Docs](https://www.saqqdy.com/js-cool#waiting)
+
+## 2023.09.11 v5.8.0
+
+1. `compareVersion` support tag version [API Docs](https://www.saqqdy.com/js-cool#compareversion)
+
+## 2023.09.06 v5.7.2
+
+1. fix regexp bug of appVersion
+
+## 2023.09.01 v5.7.1
+
+1. revert nextIndex function
+
+## 2023.08.22 v5.7.0
+
+1. new `isIterable` function, see: [isIterable](https://github.com/saqqdy/js-cool#isiterable)
+2. Extend awaitTo to support passing in multiple promises, see: [awaitTo](https://github.com/saqqdy/js-cool#awaitto)
+3. fix types
+4. upgrade all packages
+
+## 2023.08.18 v5.6.0
+
+1. new `getCookies` function, see: [getCookies](https://github.com/saqqdy/js-cool#getcookies)
+2. some improvements for getType/getSession/getCache/fixNumber
+3. fix bugs: toThousands/parseUrlParam
+4. new pattern.number/nextIndex
+5. deprecated getScrollPosition
+6. fix types
+
+## 2023.08.10 v5.5.0
+
+1. new `preloader` `escape` `unescape` `randomColor` `isDarkMode` `waiting` function, see: [preloader](https://github.com/saqqdy/js-cool#preloader), [escape](https://github.com/saqqdy/js-cool#escape), [unescape](https://github.com/saqqdy/js-cool#unescape), [randomColor](https://github.com/saqqdy/js-cool#randomcolor), [isDarkMode](https://github.com/saqqdy/js-cool#isdarkmode), [waiting](https://github.com/saqqdy/js-cool#waiting)
+
+## 2023.08.05 v5.4.0
+
+1. new `shuffle` `randomNumbers` function, see: [shuffle](https://github.com/saqqdy/js-cool#shuffle), [randomNumbers](https://github.com/saqqdy/js-cool#randomnumbers)
+2. Band new randomString function, see: [randomString](https://github.com/saqqdy/js-cool#randomstring)
+
+## 2023.08.02 v5.3.2
+
+1. Optimize usage of `getQueryParams` `getUrlParams`
+2. upgrade all packages
+
+## 2023.07.31 v5.3.1
+
+1. fix appVersion bug
+
+## 2023.07.18 v5.3.0
+
+1. new `spliceUrlParam` function
+2. deprecated `isDigitals`
+3. fix types & bugs
+4. docs work
+
+## 2023.07.17 v5.2.0
+
+1. new `awaitTo` `fingerprint` `browserVersion` function
+2. fix bugs of `osVersion`
+3. deprecated `trim` `pattern` `getDirParam`
+4. docs work
+
+## 2023.07.07 v5.1.0
+
+1. add `appVersion` `osVersion`
+2. deprecated `getOsVersion` `getAppVersion`
+
+## 2023.07.05 v5.0.0
+
+1. add `copy` `getQueryParam` `getQueryParams` `getUrlParams` function
+2. change the params of `getUrlParam`
+3. add `isWindow` function
+4. add `isObject` `isArray` function
+5. remove `getRandomStrWidthSpecialChar`
+6. remove `getParameter`
+7. remove `getIsAppVersionLastest`, use `compareVersion` instead
+8. `searchTreeObject` rename to `searchObject`
+9. `getRandomNum` rename to `randomNumber`
+10. `getRandomStr` rename to `randomString`
+11. upgrade all packages
+
+## 2023.06.14 v4.7.0
+
+1. add `compareVersion` [API Docs](https://www.saqqdy.com/js-cool#compareversion)
+2. upgrade all packages
+
+## 2023.06.06 v4.6.0
+
+1. drop `textareaInsertText` & `textareaMoveToEnd`, If you still need to use it, we using [grace-textarea](https://github.com/saqqdy/grace-textarea)
+
+## 2023.06.05 v4.5.0
+
+1. add `inBrowser` [API Docs](https://www.saqqdy.com/js-cool#inbrowser)
+2. some translate work
+3. upgrade all packages
+
+## 2023.05.31 v4.4.1
+
+1. fix esm module
+
+## 2023.05.23 v4.4.0
+
+1. fix outputs
+2. fix exports
+
+## 2023.05.22 v4.3.0
+
+1. fix export default
+2. fix types
+3. upgrade all packages
+
+## 2023.05.21 v4.2.0
+
+1. use `use-downloads`
+2. some translate work
+
+## 2023.05.20 v4.1.0
+
+1. use `load-source` `mount-css` `mount-image` `mount-script` `mount-style`
+2. some translate work
+
+## 2023.05.18 v4.0.0
+
+1. split `csv` into `arrayToCSV` `CSVToArray` `CSVToJSON` `JSONToCSV`
+2. split `cache` into `setCache` `getCache` `delCache`
+3. split `session`into `setSession` `getSession` `delSession`
+4. split `cookie` into `setCookie` `getCookie` `delCookie`
+5. drop `tslib` package
+6. new build scripts & output
+
+## 2023.04.07 v3.1.0
+
+1. Optimize build output by removing `tslib` from the package
+
+## 2023.04.06 v3.0.0
+
+1. remove `imgAdapt` `imgChoose` `throttle` `debounce` `enWxJumpLink` `enWxJumpLinkOld` `deWxJumpLink` `deWxJumpLinkOld` `clearHtmlExpSN` ` clearHtmlN` `clearHtmlNS` `clearHtmlTag` `formatTime` `formatTimeStr` `getFileType` `clearBr`
+2. move `arrayToCSV` `CSVToArray` `CSVToJSON` `JSONToCSV` to `csv`
+3. move `setCache` `getCache` `delCache` to `cache`
+4. move `setSession` `getSession` `delSession` to `session`
+5. move `setCookie` `getCookie` `delCookie` to `cookie`
+6. add `isPlainObject` function
+7. support `const addEvent = require('js-cool/addEvent')` This introduction method
+8. build product differentiate between esnext and es5, default output esnext
+9. `splitThousand` => `toThousands`
+10. `getWindowSize` => `windowSize`
+11. new `extend` function
+
+## 2022.12.13 v2.8.0
+
+1. `loadSource` `mountCss` `mountImg` `mountJs` `mountStyle` new support for passing in custom properties, adjusting the input form, and improving the ts type, fixing IE compatibility issues
+2. dependency package upgrade
+
+## 2022.12.07 v2.7.1
+
+Extend the types supported by `getType` method.
+
+## 2022.12.04 v2.7.0
+
+1. add `setProperty` method
+2. fix getProperty bug
+
+## 2022.12.04 v2.6.0
+
+1. add `loadSource` `mountCss` `mountImg` `mountJs` `mountStyle` 5 methods
+2. upgrade the dependency package
+
+## 2022.09.10 v2.5.0
+
+1. adjust exports export method, focus on supporting node esm mode
+2. optimize build scripts
+3. upgrade dependency packages
+
+## 2022.08.23 v2.4.0
+
+1. upgrade dependency packages
+2. optimize the build process
+
+## 2022.03.12 v2.3.2
+
+1. upgrade dependency packages
+2. optimize the documentation
+
+## 2022.02.25 v2.3.1
+
+1. fix `tslib` package issue
+
+## 2021.11.11 v2.3.0
+
+1. export module to keep default
+2. upgrade dependency package
+
+## 2021.10.23 v2.2.4
+
+1. add getProperty method
+
+## 2021.10.19 v2.2.3
+
+1. improve fillIPv6 method
+
+## 2021.10.18 v2.2.2
+
+1. add fillIPv6 method
+
+## 2021.10.15 v2.2.1
+
+1. add methods to find the intersection, concatenation, difference and complement of multiple arrays
+2. add contains method
+3. add a unique method for de-duplication
+
+## 2021.09.21 v2.1.3
+
+1. build output banner
+
+## 2021.09.10 v2.1.2
+
+1. improve typescript types
+2. upgrade dependency package
+
+## 2021.09.02 v2.1.1
+
+1. refine typescript types
+
+## 2021.08.29 v2.1.0
+
+1. add build es module
+
+## 2021.08.28 v2.0.1
+
+1. fix several issues
+2. optimize code, optimize documentation
+
+## 2021.08.26 v2.0.0
+
+1. refactor all the code to typescript
+2. rewrite method comments according to tsdoc specification
+
+## 2021.07.26 v1.1.0
+
+1. use webpack to build umd package
+
+## 2021.03.03 v1.0.9
+
+1. add all/any/RGBToHex/uuid methods
+2. add CSV to object conversion methods: arrayToCSV/CSVToArray/CSVToJSON/JSONtoCSV
+
+## 2021.03.02 v1.0.8
+
+1. add splitThousand method
+
+## 2021.03.01 v1.0.7
+
+1. fix nextIndex bug
+
+## 2021.02.18 v1.0.6
+
+1. add openUrl method
+
+## 2021.02.18 v1.0.5
+
+1. add download/searchTreeObject method
+
+## 2021.02.08 v1.0.4
+
+1. update getCookie/setCookie methods
+
+## 2021.02.01 v1.0.3
+
+1. handle bugs
+
+## 2021.01.23 v1.0.2
+
+1. add nextIndex,fixNumber,delay,extend,getType,isArray,cleanData,getCache,setCache,delCache
+2. delete getLocal,setLocal,delLocal
+
+## 2020.12.14 v1.0.1
+
+1. create project
diff --git a/media/LICENSE b/media/LICENSE
new file mode 100644
index 0000000..d2570ec
--- /dev/null
+++ b/media/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 saqqdy
+
+# js-cool
+
+这是一个 Javascript 常用方法库
+
+[![NPM version][npm-image]][npm-url]
+[![Codacy Badge][codacy-image]][codacy-url]
+[![tree shaking][tree-shaking-image]][tree-shaking-url]
+![typescript][typescript-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![npm download][download-image]][download-url]
+[![gzip][gzip-image]][gzip-url]
+[![License][license-image]][license-url]
+
+[![Sonar][sonar-image]][sonar-url]
+
+
+
+
+
+### **[Documentation](https://www.saqqdy.com/js-cool)** • **[Change Log](./CHANGELOG.md)**
+
+**使用其他语言阅读：[English](./README.md) | 简体中文**
+
+
+
+## 安装
+
+```bash
+# 使用pnpm安装
+pnpm install js-cool
+
+# 使用npm安装
+npm install --save js-cool
+```
+
+## 使用
+
+### ES6 模块方式引入
+
+```js
+import { osVersion } from 'js-cool'
+
+osVersion()
+```
+
+### Node.js require
+
+```js
+const { osVersion } = require('js-cool')
+
+osVersion()
+```
+
+2. 使用 CDN 引入
+
+```html
+
+
+```
+
+## 所有方法汇总
+
+```js
+const functionList = {
+ // 全局参数
+ client, // client方法返回一个浏览器判断结果对象
+ pattern, // pattern返回一些常用的正则
+ // String扩展、数组方法
+ trim, // 根据传参来去除空格
+ clearAttr, // 去除HTML标签所有属性
+ clearHtml, // 去除HTML标签
+ escape, // 转义HTML特殊字符
+ unescape, // 还原转义HTML特殊字符
+ getNumber, // 获取字符串中的数字
+ camel2Dash, // 将驼峰字符串转成-间隔且全小写的Dash模式
+ dash2Camel, // 将-间隔且全小写的Dash模式转成驼峰字符串
+ randomColor, // 生成随机16进制颜色
+ randomNumber, // 获取随机整数
+ randomNumbers, // 获取总和固定的n个随机整数
+ randomString, // 获取随机字符串
+ shuffle, // 打乱字符串或数组的顺序
+ fingerprint, // 生成浏览器指纹
+ getCHSLength, // 获取字符串长度，中文算2个字符
+ cutCHSString, // 截取字符串，中文算2个字节
+ // 获取一下状态
+ isDigitals, // 是否为由数字组成的字符串
+ isExitsFunction, // 是否存在指定函数
+ isExitsVariable, // 是否存在指定变量
+ isEqual, // 比较2个对象是否相等
+ isWindow, // 是否window对象
+ isPlainObject, // 是否plainObject
+ isDarkMode, // 是否暗色模式
+ isObject, // 是否object类型
+ isDate, // 是否日期类型
+ isRegExp, // 是否正则类型
+ isArray, // 判断是否数组
+ isIterable, // 判断是否可迭代对象
+ inBrowser, // 判断是否在浏览器端运行
+ inNodeJs, // 判断是否在nodejs环境运行
+ isNumberBrowser, // 判断是否360浏览器
+ windowSize, // windowSize获取窗口大小
+ getAppVersion, // 获取APP版本号(deprecated)
+ appVersion, // 获取APP版本号
+ getOsVersion, // 获取系统版本(deprecated)
+ osVersion, // 获取系统名称和版本
+ browserVersion, // 获取浏览器版本
+ compareVersion, // 版本号大小对比
+ parseUrlParam, // 解析url参数（key1=value1&key2=value2）
+ spliceUrlParam, // 拼接URL参数（仅支持单层）
+ safeParse, // 安全解析JSON字符串
+ safeStringify, // 安全转换JSON对象为字符串
+ getDirParam, // 获取目录形式URL参数
+ getQueryParam, // 获取query参数（#后面）
+ getQueryParams, // 获取所有query参数（#后面）
+ getUrlParam, // 获取单个URL参数
+ getUrlParams, // 获取所有URL参数
+ // 缓存、cookie、session
+ getCache, // 读取localStorage
+ setCache, // 写入localStorage
+ delCache, // 删除localStorage
+ getSession, // 读取sessionStorage
+ setSession, // 写入sessionStorage
+ delSession, // 删除sessionStorage
+ getCookie, // 读取cookie
+ getCookies, // 读取所有cookie
+ setCookie, // 写入cookie
+ delCookie, // 删除cookie
+ // 编码与解码
+ encodeBase64, // 字符串、数字转base64
+ encodeUtf8, // 编码Utf8
+ decodeBase64, // base64解码
+ decodeUtf8, // 解码Utf8
+ // 事件委托、其他事件方法
+ stopBubble, // 阻止冒泡
+ stopDefault, // 阻止默认事件
+ addEvent, // 事件委托，支持多次委托
+ removeEvent, // removeEvent移除由addEvent创建的事件委托
+ getScrollPosition, // 获取滑动到顶部和底部 返回'top' 'bottom'，建议使用限流
+ // 工具类
+ nextIndex, // 返回下一个zIndex值
+ nextVersion, // 返回下一个版本号
+ punctualTimer, // 准时的setInterval
+ promiseFactory, // 将一个对象转换为promise like api
+ fixNumber, // 截取小数点后几位，不足的不补0
+ mapTemplate, // 替换模板字符串的特定数据
+ extend, // 深拷贝&合并对象
+ clone, // 深拷贝 (不支持Buffer、Promise、Set、Map)
+ delay, // 防抖节流
+ getType, // 获取目标类型
+ getFileType, // 根据链接后缀判断文件类型
+ sorter, // 排序工厂函数
+ sortPinyin, // 中文按拼音排序
+ cleanData, // 清洗数据
+ download, // 文件下载
+ searchObject, // 对象查找
+ openUrl, // 新标签页打开链接（浏览器不能解析的文件跳转下载）
+ copy, // 复制到剪贴板
+ toThousands, // 千分位分割方法
+ all, // 如果所提供的谓词函数对一个集合中的所有元素都返回true，则返回true，否则返回false。
+ any, // 如果所提供的谓词函数对一个集合中的至少一个元素返回true，则返回true，否则返回false。
+ uuid, // 浏览器端生成uuid，采用v4方法
+ CSVToArray, // csv与json、array相互转换
+ arrayToCSV, // csv与json、array相互转换
+ CSVToJSON, // csv与json、array相互转换
+ JSONToCSV, // csv与json、array相互转换
+ RGBToHex, // 将RGB组件的值转换为颜色代码。
+ intersect, // 多个数组求交集
+ union, // 求多个数组的并集
+ minus, // 求多个数组的差集，属于A但不属于B/C/D...的元素
+ complement, // 多个数组求补集
+ contains, // 数组是否包含指定元素
+ unique, // 数组去重
+ fillIPv6, // ipv6地址补全
+ getProperty, // 根据路径字符串获取数组、对象属性值
+ setProperty, // 根据路径字符串设置数组、对象属性值
+ loadSource, // 动态加载资源，支持js、图片、css链接、css样式字符串
+ mountCss, // 动态加载css链接资源
+ mountImg, // 动态加载图片资源
+ mountJs, // 动态加载js链接资源
+ mountStyle, // 动态加载css样式
+ preloader, // 图片预加载
+ waiting, // 等待一段时间
+ awaitTo, // 替代try catch处理promise错误
+ // 二进制
+ arrayBufferToBase64, // arrayBuffer转Base64
+ arrayBufferToBlob, // arrayBuffer转Blob
+ base64ToArrayBuffer, // base64转ArrayBuffer
+ base64ToBlob, // base64转Blob
+ base64ToFile, // base64转File
+ blobToArrayBuffer, // blob转ArrayBuffer
+ blobToBase64, // blob转Base64
+ blobToUrl, // blob转Url
+ fileToBase64, // file转Base64
+ svgToBlob, // svg转Blob
+ urlToBlob // url转Blob
+}
+```
+
+## 问题和支持
+
+请提交一个 issue [here](https://github.com/saqqdy/js-cool/issues).
+
+## License
+
+[MIT](LICENSE)
+
+[npm-image]: https://img.shields.io/npm/v/js-cool.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/js-cool
+[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
+[codacy-url]: https://www.codacy.com/gh/saqqdy/js-cool/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/js-cool&utm_campaign=Badge_Grade
+[tree-shaking-image]: https://badgen.net/bundlephobia/tree-shaking/js-cool
+[tree-shaking-url]: https://bundlephobia.com/package/js-cool
+[typescript-url]: https://badgen.net/badge/icon/typescript?icon=typescript&label
+[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/js-cool.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/saqqdy/js-cool?branch=master
+[download-image]: https://img.shields.io/npm/dm/js-cool.svg?style=flat-square
+[download-url]: https://npmjs.org/package/js-cool
+[gzip-image]: http://img.badgesize.io/https://unpkg.com/js-cool/dist/index.global.prod.js?compression=gzip&label=gzip%20size:%20JS
+[gzip-url]: http://img.badgesize.io/https://unpkg.com/js-cool/dist/index.global.prod.js?compression=gzip&label=gzip%20size:%20JS
+[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
+[license-url]: LICENSE
+[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_js-cool
+[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_js-cool
diff --git a/modules.html b/modules.html
new file mode 100644
index 0000000..e8c7436
--- /dev/null
+++ b/modules.html
@@ -0,0 +1 @@
+JS-COOL DOCS - v5.23.1
Interfaces
Type Aliases
Functions
- awaitTo
- loadSource
- mountCss
- mountImg
- mountJs
- mountStyle
- download
- CSVToArray
- CSVToJSON
- JSONToCSV
- RGBToHex
- addEvent
- all
- any
- appVersion
- arrayBufferToBase64
- arrayBufferToBlob
- arrayToCSV
- base64ToArrayBuffer
- base64ToBlob
- base64ToFile
- blobToArrayBuffer
- blobToBase64
- blobToUrl
- browserVersion
- camel2Dash
- cleanData
- clearAttr
- clearHtml
- client
- clone
- compareVersion
- complement
- contains
- copy
- cutCHSString
- dash2Camel
- decodeBase64
- decodeUtf8
- delCache
- delCookie
- delSession
- delay
- encodeBase64
- encodeUtf8
- escape
- extend
- fileToBase64
- fillIPv6
- fingerprint
- fixNumber
- getAppVersion
- getCHSLength
- getCache
- getCookie
- getCookies
- getDirParam
- getFileType
- getNumber
- getOsVersion
- getProperty
- getQueryParam
- getQueryParams
- getScrollPosition
- getSession
- getType
- getUrlParam
- getUrlParams
- intersect
- isArray
- isDarkMode
- isDate
- isDigitals
- isEqual
- isExitsFunction
- isExitsVariable
- isIterable
- isNumberBrowser
- isObject
- isPlainObject
- isRegExp
- isWindow
- mapTemplate
- minus
- nextIndex
- nextVersion
- openUrl
- osVersion
- parseUrlParam
- preloader
- promiseFactory
- punctualTimer
- randomColor
- randomNumber
- randomNumbers
- randomString
- removeEvent
- safeParse
- safeStringify
- searchObject
- setCache
- setCookie
- setProperty
- setSession
- shuffle
- sortPinyin
- sorter
- spliceUrlParam
- stopBubble
- stopDefault
- svgToBlob
- toThousands
- trim
- unescape
- union
- unique
- upperFirst
- urlToBlob
- uuid
- waiting
- windowSize
test
string
')\n// '<div>test<br />string</div>'\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "5.5.0"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- newString"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/escape.ts",
+ "line": 13,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/escape.ts#L13"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 94,
+ "name": "string",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "string with html tags"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ },
+ {
+ "id": 784,
+ "name": "ExtendArrayData",
+ "variant": "declaration",
+ "kind": 2097152,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/extend.ts",
+ "line": 5,
+ "character": 12,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L5"
+ }
+ ],
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "intrinsic",
+ "name": "any"
+ }
+ }
+ },
+ {
+ "id": 785,
+ "name": "ExtendObjectData",
+ "variant": "declaration",
+ "kind": 2097152,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/extend.ts",
+ "line": 7,
+ "character": 12,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L7"
+ }
+ ],
+ "type": {
+ "type": "reference",
+ "target": {
+ "sourceFileName": "node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.es5.d.ts",
+ "qualifiedName": "Record"
+ },
+ "typeArguments": [
+ {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ {
+ "type": "intrinsic",
+ "name": "any"
+ }
+ ],
+ "name": "Record",
+ "package": "typescript"
+ }
+ },
+ {
+ "id": 786,
+ "name": "ExtendData",
+ "variant": "declaration",
+ "kind": 2097152,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/extend.ts",
+ "line": 9,
+ "character": 12,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L9"
+ }
+ ],
+ "type": {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "target": 784,
+ "name": "ExtendArrayData",
+ "package": "js-cool"
+ },
+ {
+ "type": "reference",
+ "target": 785,
+ "name": "ExtendObjectData",
+ "package": "js-cool"
+ }
+ ]
+ }
+ },
+ {
+ "id": 771,
+ "name": "extend",
+ "variant": "declaration",
+ "kind": 64,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/extend.ts",
+ "line": 41,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L41"
+ },
+ {
+ "fileName": "src/extend.ts",
+ "line": 42,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L42"
+ },
+ {
+ "fileName": "src/extend.ts",
+ "line": 43,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L43"
+ },
+ {
+ "fileName": "src/extend.ts",
+ "line": 44,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L44"
+ },
+ {
+ "fileName": "src/extend.ts",
+ "line": 45,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L45"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 772,
+ "name": "extend",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "deep copy & merge objects"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.2"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/extend.ts",
+ "line": 41,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L41"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 773,
+ "name": "target",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "boolean | ExtendData"
+ }
+ ]
+ },
+ "type": {
+ "type": "reference",
+ "target": 785,
+ "name": "ExtendObjectData",
+ "package": "js-cool"
+ }
+ },
+ {
+ "id": 774,
+ "name": "args",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {
+ "isRest": true
+ },
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ArrayOneMorestring
test
string
')\n// '<div>test<br />string</div>'\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "5.5.0"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- newString"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/escape.ts",
+ "line": 13,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/escape.ts#L13"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1118,
+ "name": "string",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "string with html tags"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1119,
+ "name": "unescape",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 162,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L162"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1120,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/unescape.ts",
+ "line": 13,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/unescape.ts#L13"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1121,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Restore HTML Special Characters"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nunescape('<div>test<br />string</div>')\n// 'string
test
string
'\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "5.5.0"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- newString"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/unescape.ts",
+ "line": 13,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/unescape.ts#L13"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1122,
+ "name": "string",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "string"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1123,
+ "name": "client",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 163,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L163"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1124,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 10,
+ "character": 15,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L10"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1125,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The client method returns a browser judgment result: "
+ },
+ {
+ "kind": "code",
+ "text": "`{ ANDROID: true, GECKO: true, GLSH_APP: false, IE: false, IOS: false, IPAD: false, IPHONE: false, MOBILE: true, MOBILEDEVICE. true, OPERA: false, QQ: false, QQBROWSER: false, TRIDENT: false, WEBKIT: true, WEIXIN: false }`"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@deprecated",
+ "content": [
+ {
+ "kind": "text",
+ "text": "Will be refactored for the next major release"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- the common ua match table, if name is passed, then returns whether the terminal matches true/false"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 10,
+ "character": 15,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L10"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1126,
+ "name": "name",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "optional, e.g. pass in MicroMessenger to return whether it is the built-in browser of Weixin"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ "defaultValue": "''"
+ },
+ {
+ "id": 1127,
+ "name": "userAgent",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "optional, pass in a custom ua, default takes the browser's navigator.userAgent"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ "defaultValue": "navigator.userAgent"
+ }
+ ],
+ "type": {
+ "type": "union",
+ "types": [
+ {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ {
+ "type": "reflection",
+ "declaration": {
+ "id": 1128,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "children": [
+ {
+ "id": 1129,
+ "name": "IE",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 16,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L16"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1130,
+ "name": "GECKO",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 17,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L17"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1131,
+ "name": "WEBKIT",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 18,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L18"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1132,
+ "name": "OPERA",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 19,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L19"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1133,
+ "name": "TRIDENT",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 20,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L20"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1134,
+ "name": "MOBILE",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 21,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L21"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1135,
+ "name": "IOS",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 23,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L23"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1136,
+ "name": "ANDROID",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 24,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L24"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1137,
+ "name": "IPHONE",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 25,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L25"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1138,
+ "name": "IPAD",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 26,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L26"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1139,
+ "name": "QQBROWSER",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 28,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L28"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1140,
+ "name": "WEIXIN",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 29,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L29"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1141,
+ "name": "QQ",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 30,
+ "character": 3,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L30"
+ }
+ ],
+ "type": {
+ "type": "union",
+ "types": [
+ {
+ "type": "literal",
+ "value": null
+ },
+ {
+ "type": "reference",
+ "target": {
+ "sourceFileName": "node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.es5.d.ts",
+ "qualifiedName": "RegExpMatchArray"
+ },
+ "name": "RegExpMatchArray",
+ "package": "typescript"
+ }
+ ]
+ },
+ "defaultValue": "..."
+ }
+ ],
+ "groups": [
+ {
+ "title": "Properties",
+ "children": [
+ 1129,
+ 1130,
+ 1131,
+ 1132,
+ 1133,
+ 1134,
+ 1135,
+ 1136,
+ 1137,
+ 1138,
+ 1139,
+ 1140,
+ 1141
+ ]
+ }
+ ],
+ "sources": [
+ {
+ "fileName": "src/client.ts",
+ "line": 15,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/client.ts#L15"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1142,
+ "name": "complement",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 164,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L164"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1143,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/complement.ts",
+ "line": 16,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/complement.ts#L16"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1144,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Find the complement of multiple arrays"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\ncomplement([1, 2], [2, '33'], [2]) // [1, '33']\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "2.2.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "array"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/complement.ts",
+ "line": 16,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/complement.ts#L16"
+ }
+ ],
+ "typeParameters": [
+ {
+ "id": 1145,
+ "name": "T",
+ "variant": "typeParam",
+ "kind": 131072,
+ "flags": {},
+ "default": {
+ "type": "intrinsic",
+ "name": "unknown"
+ }
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1146,
+ "name": "args",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {
+ "isRest": true
+ },
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "arguments"
+ }
+ ]
+ },
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "array",
+ "elementType": {
+ "type": "reference",
+ "target": 906,
+ "name": "T",
+ "package": "js-cool",
+ "refersToTypeParameter": true
+ }
+ }
+ }
+ }
+ ],
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "reference",
+ "target": 906,
+ "name": "T",
+ "package": "js-cool",
+ "refersToTypeParameter": true
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1147,
+ "name": "contains",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 165,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L165"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1148,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/contains.ts",
+ "line": 14,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/contains.ts#L14"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1149,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Whether the array contains the specified element"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\ncontains([1, 2], 2) // true\ncontains([1, 2], 3) // false\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "2.2.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "boolean"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/contains.ts",
+ "line": 14,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/contains.ts#L14"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1150,
+ "name": "arr",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the target array"
+ }
+ ]
+ },
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "intrinsic",
+ "name": "any"
+ }
+ }
+ },
+ {
+ "id": 1151,
+ "name": "item",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the target to find"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "any"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1152,
+ "name": "CSVToArray",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 166,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L166"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1153,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/CSVToArray.ts",
+ "line": 21,
+ "character": 19,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/CSVToArray.ts#L21"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1154,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Converts a comma-separated string of values (CSV) to a 2D array."
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nCSVToArray('a,b\\\\nc,d')\n// `[['a','b'],['c','d']]`.\n\nCSVToArray('a;b\\\\\\nc;d', ';')\n// `[['a','b'],['c','d']]`.\n\nCSVToArray('col1,col2\\\\\\na,b\\\\\\nc,d', ',', true)\n// `[['a','b'],['c','d']]`.\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.9"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "array"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/CSVToArray.ts",
+ "line": 21,
+ "character": 19,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/CSVToArray.ts#L21"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1155,
+ "name": "data",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "csv data"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ },
+ {
+ "id": 1156,
+ "name": "delimiter",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "separator, default ','"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ "defaultValue": "','"
+ },
+ {
+ "id": 1157,
+ "name": "omitFirstRow",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the first row is the table header data, default false"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "false"
+ }
+ ],
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "array",
+ "elementType": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1158,
+ "name": "arrayToCSV",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 167,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L167"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1159,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/arrayToCSV.ts",
+ "line": 20,
+ "character": 19,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/arrayToCSV.ts#L20"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1160,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Converts a two-dimensional array to a comma-separated string of values (CSV)."
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\narrayToCSV([['a', 'b'], ['c', 'd']])\n// '\"a\", \"b\" \\n \"c\", \"d\"'\n\narrayToCSV([['a', 'b'], ['c', 'd']], ';')\n// '\"a\"; \"b\"\\n \"c\"; \"d\"'\n\narrayToCSV([['a', '\"b\" great'], ['c', 3.1415]])\n// '\"a\", \"\"\"b\"\" great\"\\n \"c\",3.1415'\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.9"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "CSV data"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/arrayToCSV.ts",
+ "line": 20,
+ "character": 19,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/arrayToCSV.ts#L20"
+ }
+ ],
+ "typeParameters": [
+ {
+ "id": 1161,
+ "name": "T",
+ "variant": "typeParam",
+ "kind": 131072,
+ "flags": {},
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "array",
+ "elementType": {
+ "type": "intrinsic",
+ "name": "unknown"
+ }
+ }
+ }
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1162,
+ "name": "arr",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "reference",
+ "target": 875,
+ "name": "T",
+ "package": "js-cool",
+ "refersToTypeParameter": true
+ }
+ },
+ {
+ "id": 1163,
+ "name": "delimiter",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "delimiter, default ','"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ "defaultValue": "','"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1164,
+ "name": "CSVToJSON",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 168,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L168"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1165,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/CSVToJSON.ts",
+ "line": 17,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/CSVToJSON.ts#L17"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1166,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Converts a comma-separated string of values (CSV) to an array of 2D objects. The first line of the string is used as the header line."
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nCSVToJSON('col1,col2\\\\na,b\\\\\\nc,d')\n// `[{'col1': 'a', 'col2': 'b'}, {'col1': 'c', 'col2': 'd'}]`.\n\nCSVToJSON('col1;col2\\\\\\na;b\\\\\\nc;d', ';')\n// `[{'col1': 'a', 'col2': 'b'}, {'col1': 'c', 'col2': 'd'}]`.\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.9"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- json"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/CSVToJSON.ts",
+ "line": 17,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/CSVToJSON.ts#L17"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1167,
+ "name": "data",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "csv data"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ },
+ {
+ "id": 1168,
+ "name": "delimiter",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "delimiter, default ','"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ "defaultValue": "','"
+ }
+ ],
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "intrinsic",
+ "name": "any"
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1169,
+ "name": "JSONToCSV",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 169,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L169"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1170,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/JSONToCSV.ts",
+ "line": 18,
+ "character": 18,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/JSONToCSV.ts#L18"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1171,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Converts an array of objects to a comma-separated value (CSV) string containing only the specified columns."
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nJSONToCSV([{ a: 1, b: 2 }, { a: 3, b: 4, c: 5 }, { a: 6 }, { b: 7 }], ['a', 'b'])\n// 'a,b\\n \"1\", \"2\"\\n \"3\", \"4\"\\n \"6\",\"\"\\n\"\", \"7\"'\n\nJSONToCSV([{ a: 1, b: 2 }, { a: 3, b: 4, c: 5 }, { a: 6 }, { b: 7 }], ['a', 'b'], ';')\n// 'a;b\\n \"1\"; \"2\"\\n \"3\"; \"4\"\\n \"6\";\"\"\\n\"\"; \"7\"'\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.9"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- CSV data"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/JSONToCSV.ts",
+ "line": 18,
+ "character": 18,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/JSONToCSV.ts#L18"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1172,
+ "name": "arr",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "intrinsic",
+ "name": "any"
+ }
+ }
+ },
+ {
+ "id": 1173,
+ "name": "columns",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the specified columns"
+ }
+ ]
+ },
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "intrinsic",
+ "name": "any"
+ }
+ }
+ },
+ {
+ "id": 1174,
+ "name": "delimiter",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "delimiter, default ','"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ "defaultValue": "','"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1175,
+ "name": "cutCHSString",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 170,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L170"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1176,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/cutCHSString.ts",
+ "line": 10,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/cutCHSString.ts#L10"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1177,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Intercept string, Chinese counts as 2 bytes"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- the intercepted string"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/cutCHSString.ts",
+ "line": 10,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/cutCHSString.ts#L10"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1178,
+ "name": "str",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the string to be intercepted"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ },
+ {
+ "id": 1179,
+ "name": "len",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ },
+ "defaultValue": "str.length"
+ },
+ {
+ "id": 1180,
+ "name": "hasDot",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "false"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1181,
+ "name": "dash2Camel",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 171,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L171"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1182,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/dash2Camel.ts",
+ "line": 8,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/dash2Camel.ts#L8"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1183,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Converts -spaced and all lowercase Dash patterns to humped strings"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- the converted string"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/dash2Camel.ts",
+ "line": 8,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/dash2Camel.ts#L8"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1184,
+ "name": "string",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the string to be converted"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1185,
+ "name": "decodeBase64",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 172,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L172"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1186,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/decodeBase64.ts",
+ "line": 11,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/decodeBase64.ts#L11"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1187,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "base64 decoding"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "decoded string"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/decodeBase64.ts",
+ "line": 11,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/decodeBase64.ts#L11"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1188,
+ "name": "input",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the string to be decoded"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1189,
+ "name": "decodeUtf8",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 173,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L173"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1190,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/decodeUtf8.ts",
+ "line": 8,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/decodeUtf8.ts#L8"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1191,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Decoding Utf8"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "decoded string"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/decodeUtf8.ts",
+ "line": 8,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/decodeUtf8.ts#L8"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1192,
+ "name": "utftext",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1193,
+ "name": "delay",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 174,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L174"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1194,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/delay.ts",
+ "line": 9,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/delay.ts#L9"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1195,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "debounce & throttle"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.2"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "class"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/delay.ts",
+ "line": 9,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/delay.ts#L9"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1196,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "children": [
+ {
+ "id": 1197,
+ "name": "map",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/delay.ts",
+ "line": 11,
+ "character": 2,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/delay.ts#L11"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "any"
+ },
+ "defaultValue": "..."
+ },
+ {
+ "id": 1198,
+ "name": "register",
+ "variant": "declaration",
+ "kind": 2048,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/delay.ts",
+ "line": 12,
+ "character": 2,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/delay.ts#L12"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1199,
+ "name": "register",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/delay.ts",
+ "line": 12,
+ "character": 2,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/delay.ts#L12"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1200,
+ "name": "id",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ },
+ {
+ "id": 1201,
+ "name": "fn",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "reference",
+ "target": 987,
+ "name": "AnyFunction",
+ "package": "js-cool"
+ }
+ },
+ {
+ "id": 1202,
+ "name": "time",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ },
+ {
+ "id": 1203,
+ "name": "boo",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "void"
+ }
+ }
+ ]
+ },
+ {
+ "id": 1204,
+ "name": "destroy",
+ "variant": "declaration",
+ "kind": 2048,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/delay.ts",
+ "line": 43,
+ "character": 2,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/delay.ts#L43"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1205,
+ "name": "destroy",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/delay.ts",
+ "line": 43,
+ "character": 2,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/delay.ts#L43"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1206,
+ "name": "id",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "void"
+ }
+ }
+ ]
+ }
+ ],
+ "groups": [
+ {
+ "title": "Properties",
+ "children": [
+ 1197
+ ]
+ },
+ {
+ "title": "Methods",
+ "children": [
+ 1198,
+ 1204
+ ]
+ }
+ ],
+ "sources": [
+ {
+ "fileName": "src/delay.ts",
+ "line": 10,
+ "character": 8,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/delay.ts#L10"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1207,
+ "name": "encodeBase64",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 175,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L175"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1208,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/encodeBase64.ts",
+ "line": 11,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/encodeBase64.ts#L11"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1209,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "String, number to base64"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- the BASE64 encoding"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/encodeBase64.ts",
+ "line": 11,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/encodeBase64.ts#L11"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1210,
+ "name": "input",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the string to be encoded"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1211,
+ "name": "encodeUtf8",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 176,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L176"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1212,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/encodeUtf8.ts",
+ "line": 8,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/encodeUtf8.ts#L8"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1213,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Encoding Utf8"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- the UTF-8 encoding"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/encodeUtf8.ts",
+ "line": 8,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/encodeUtf8.ts#L8"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1214,
+ "name": "string",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "id": 1215,
+ "name": "extend",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/index.default.ts",
+ "line": 177,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/index.default.ts#L177"
+ }
+ ],
+ "type": {
+ "type": "reflection",
+ "declaration": {
+ "id": 1216,
+ "name": "__type",
+ "variant": "declaration",
+ "kind": 65536,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/extend.ts",
+ "line": 41,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L41"
+ },
+ {
+ "fileName": "src/extend.ts",
+ "line": 42,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L42"
+ },
+ {
+ "fileName": "src/extend.ts",
+ "line": 43,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L43"
+ },
+ {
+ "fileName": "src/extend.ts",
+ "line": 44,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L44"
+ },
+ {
+ "fileName": "src/extend.ts",
+ "line": 45,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L45"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 1217,
+ "name": "__type",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "deep copy & merge objects"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.2"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/extend.ts",
+ "line": 41,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/extend.ts#L41"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 1218,
+ "name": "target",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "boolean | ExtendData"
+ }
+ ]
+ },
+ "type": {
+ "type": "reference",
+ "target": 785,
+ "name": "ExtendObjectData",
+ "package": "js-cool"
+ }
+ },
+ {
+ "id": 1219,
+ "name": "args",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {
+ "isRest": true
+ },
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "ArrayOneMorestring
test
string
'\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "5.5.0"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- newString"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/unescape.ts",
+ "line": 13,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/unescape.ts#L13"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 97,
+ "name": "string",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "string"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ },
+ {
+ "id": 896,
+ "name": "union",
+ "variant": "declaration",
+ "kind": 64,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/union.ts",
+ "line": 19,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/union.ts#L19"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 897,
+ "name": "union",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Find the concatenation of multiple arrays"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nunion([1, 2], [2, '33'])\n// [1, 2, '33']\n\nunion([1, 2], [2, '33'], [1, 11, 2, '2'])\n// [ 1, 2, '33', 11, '2' ]\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "2.2.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- new array"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/union.ts",
+ "line": 19,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/union.ts#L19"
+ }
+ ],
+ "typeParameters": [
+ {
+ "id": 898,
+ "name": "T",
+ "variant": "typeParam",
+ "kind": 131072,
+ "flags": {},
+ "default": {
+ "type": "intrinsic",
+ "name": "unknown"
+ }
+ }
+ ],
+ "parameters": [
+ {
+ "id": 899,
+ "name": "args",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {
+ "isRest": true
+ },
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "arguments"
+ }
+ ]
+ },
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "array",
+ "elementType": {
+ "type": "reference",
+ "target": 898,
+ "name": "T",
+ "package": "js-cool",
+ "refersToTypeParameter": true
+ }
+ }
+ }
+ }
+ ],
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "reference",
+ "target": 898,
+ "name": "T",
+ "package": "js-cool",
+ "refersToTypeParameter": true
+ }
+ }
+ }
+ ]
+ },
+ {
+ "id": 912,
+ "name": "unique",
+ "variant": "declaration",
+ "kind": 64,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/unique.ts",
+ "line": 14,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/unique.ts#L14"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 913,
+ "name": "unique",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Array de-duplication"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nunique([1, 2, 2, '33']) // [1, 2, '33']\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "2.2.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- new array"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/unique.ts",
+ "line": 14,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/unique.ts#L14"
+ }
+ ],
+ "typeParameters": [
+ {
+ "id": 914,
+ "name": "T",
+ "variant": "typeParam",
+ "kind": 131072,
+ "flags": {},
+ "default": {
+ "type": "intrinsic",
+ "name": "unknown"
+ }
+ }
+ ],
+ "parameters": [
+ {
+ "id": 915,
+ "name": "arr",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "array data"
+ }
+ ]
+ },
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "reference",
+ "target": 914,
+ "name": "T",
+ "package": "js-cool",
+ "refersToTypeParameter": true
+ }
+ }
+ }
+ ],
+ "type": {
+ "type": "array",
+ "elementType": {
+ "type": "reference",
+ "target": 914,
+ "name": "T",
+ "package": "js-cool",
+ "refersToTypeParameter": true
+ }
+ }
+ }
+ ]
+ },
+ {
+ "id": 107,
+ "name": "upperFirst",
+ "variant": "declaration",
+ "kind": 64,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/upperFirst.ts",
+ "line": 12,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/upperFirst.ts#L12"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 108,
+ "name": "upperFirst",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "First letter capitalized"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nupperFirst('saqqdy') // Saqqdy\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- the converted string"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/upperFirst.ts",
+ "line": 12,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/upperFirst.ts#L12"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 109,
+ "name": "string",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "the string to be converted"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ },
+ {
+ "id": 983,
+ "name": "urlToBlob",
+ "variant": "declaration",
+ "kind": 64,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/urlToBlob.ts",
+ "line": 8,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/urlToBlob.ts#L8"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 984,
+ "name": "urlToBlob",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "url to blob"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "5.13.0"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- blob"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/urlToBlob.ts",
+ "line": 8,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/urlToBlob.ts#L8"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 985,
+ "name": "input",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "url"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "reference",
+ "target": {
+ "sourceFileName": "node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.es5.d.ts",
+ "qualifiedName": "Promise"
+ },
+ "typeArguments": [
+ {
+ "type": "union",
+ "types": [
+ {
+ "type": "reference",
+ "target": {
+ "sourceFileName": "node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.dom.d.ts",
+ "qualifiedName": "Blob"
+ },
+ "name": "Blob",
+ "package": "typescript"
+ },
+ {
+ "type": "literal",
+ "value": null
+ }
+ ]
+ }
+ ],
+ "name": "Promise",
+ "package": "typescript"
+ }
+ }
+ ]
+ },
+ {
+ "id": 866,
+ "name": "uuid",
+ "variant": "declaration",
+ "kind": 64,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Browser-side generation of uuid, using v4 method"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nuuid() // '4222fcfe-5721-4632-bede-6043885be57d'\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.9"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/uuid.ts",
+ "line": 11,
+ "character": 6,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/uuid.ts#L11"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 867,
+ "name": "uuid",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [],
+ "blockTags": [
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- uuid"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/uuid.ts",
+ "line": 11,
+ "character": 13,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/uuid.ts#L11"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ]
+ },
+ {
+ "id": 946,
+ "name": "waiting",
+ "variant": "declaration",
+ "kind": 64,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "waiting for a while"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "5.5.0"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/waiting.ts",
+ "line": 8,
+ "character": 6,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/waiting.ts#L8"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 947,
+ "name": "waiting",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/waiting.ts",
+ "line": 8,
+ "character": 16,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/waiting.ts#L8"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 948,
+ "name": "milliseconds",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "waiting time (milliseconds)"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ },
+ {
+ "id": 949,
+ "name": "throwOnTimeout",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "throw on timeout"
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "boolean"
+ },
+ "defaultValue": "false"
+ }
+ ],
+ "type": {
+ "type": "reference",
+ "target": {
+ "sourceFileName": "node_modules/.pnpm/typescript@5.7.3/node_modules/typescript/lib/lib.es5.d.ts",
+ "qualifiedName": "Promise"
+ },
+ "typeArguments": [
+ {
+ "type": "intrinsic",
+ "name": "void"
+ }
+ ],
+ "name": "Promise",
+ "package": "typescript"
+ }
+ }
+ ]
+ },
+ {
+ "id": 547,
+ "name": "WindowSizeObj",
+ "variant": "declaration",
+ "kind": 256,
+ "flags": {},
+ "children": [
+ {
+ "id": 548,
+ "name": "width",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/windowSize.ts",
+ "line": 2,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/windowSize.ts#L2"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ },
+ {
+ "id": 549,
+ "name": "height",
+ "variant": "declaration",
+ "kind": 1024,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/windowSize.ts",
+ "line": 3,
+ "character": 1,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/windowSize.ts#L3"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ }
+ ],
+ "groups": [
+ {
+ "title": "Properties",
+ "children": [
+ 548,
+ 549
+ ]
+ }
+ ],
+ "sources": [
+ {
+ "fileName": "src/windowSize.ts",
+ "line": 1,
+ "character": 17,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/windowSize.ts#L1"
+ }
+ ]
+ },
+ {
+ "id": 545,
+ "name": "windowSize",
+ "variant": "declaration",
+ "kind": 64,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "src/windowSize.ts",
+ "line": 16,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/windowSize.ts#L16"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 546,
+ "name": "windowSize",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "windowSize to get the window size"
+ }
+ ],
+ "blockTags": [
+ {
+ "tag": "@example",
+ "content": [
+ {
+ "kind": "code",
+ "text": "```js\nwindowSize() // { width: 1280, height: 800 }\n```"
+ }
+ ]
+ },
+ {
+ "tag": "@since",
+ "content": [
+ {
+ "kind": "text",
+ "text": "1.0.1"
+ }
+ ]
+ },
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "- the width and height"
+ }
+ ]
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "src/windowSize.ts",
+ "line": 16,
+ "character": 9,
+ "url": "https://github.com/saqqdy/js-cool/blob/dc4de44bbe9d9113a87d88b3f29eb3bf50fb226d/src/windowSize.ts#L16"
+ }
+ ],
+ "type": {
+ "type": "reference",
+ "target": 547,
+ "name": "WindowSizeObj",
+ "package": "js-cool"
+ }
+ }
+ ]
+ }
+ ],
+ "groups": [
+ {
+ "title": "Interfaces",
+ "children": [
+ 582,
+ 613,
+ 177,
+ 181,
+ 724,
+ 576,
+ 747,
+ 130,
+ 842,
+ 598,
+ 987,
+ 992,
+ 547
+ ]
+ },
+ {
+ "title": "Type Aliases",
+ "children": [
+ 784,
+ 785,
+ 786,
+ 176,
+ 180,
+ 135,
+ 986,
+ 995,
+ 997,
+ 1002,
+ 1005,
+ 1008,
+ 1011,
+ 1014
+ ]
+ },
+ {
+ "title": "Variables",
+ "children": [
+ 540,
+ 541,
+ 1019,
+ 1,
+ 60
+ ]
+ },
+ {
+ "title": "Functions",
+ "children": [
+ 27,
+ 2,
+ 6,
+ 10,
+ 14,
+ 18,
+ 22,
+ 868,
+ 878,
+ 882,
+ 887,
+ 702,
+ 856,
+ 861,
+ 555,
+ 950,
+ 954,
+ 873,
+ 958,
+ 961,
+ 964,
+ 968,
+ 971,
+ 974,
+ 579,
+ 101,
+ 831,
+ 86,
+ 89,
+ 42,
+ 787,
+ 585,
+ 904,
+ 908,
+ 850,
+ 150,
+ 104,
+ 690,
+ 693,
+ 653,
+ 681,
+ 665,
+ 791,
+ 684,
+ 687,
+ 92,
+ 771,
+ 977,
+ 916,
+ 144,
+ 760,
+ 550,
+ 147,
+ 644,
+ 668,
+ 671,
+ 610,
+ 808,
+ 98,
+ 568,
+ 919,
+ 616,
+ 622,
+ 713,
+ 656,
+ 804,
+ 630,
+ 636,
+ 892,
+ 533,
+ 522,
+ 527,
+ 155,
+ 161,
+ 158,
+ 167,
+ 536,
+ 542,
+ 524,
+ 173,
+ 530,
+ 170,
+ 764,
+ 900,
+ 715,
+ 719,
+ 847,
+ 573,
+ 589,
+ 941,
+ 753,
+ 730,
+ 110,
+ 114,
+ 118,
+ 123,
+ 708,
+ 602,
+ 606,
+ 836,
+ 647,
+ 673,
+ 934,
+ 659,
+ 136,
+ 824,
+ 814,
+ 593,
+ 696,
+ 699,
+ 980,
+ 853,
+ 83,
+ 95,
+ 896,
+ 912,
+ 107,
+ 983,
+ 866,
+ 946,
+ 545
+ ]
+ }
+ ],
+ "packageName": "js-cool",
+ "packageVersion": "5.23.1",
+ "readme": [
+ {
+ "kind": "text",
+ "text": "string
\n\n# js-cool\n\nCollection of common JavaScript / TypeScript utilities\n\n[![NPM version][npm-image]][npm-url]\n[![Codacy Badge][codacy-image]][codacy-url]\n[![tree shaking][tree-shaking-image]][tree-shaking-url]\n![typescript][typescript-url]\n[![Test coverage][codecov-image]][codecov-url]\n[![npm download][download-image]][download-url]\n[![gzip][gzip-image]][gzip-url]\n[![License][license-image]][license-url]\n\n[![Sonar][sonar-image]][sonar-url]\n\n
\n\n\n\n### **[Documentation](https://www.saqqdy.com/js-cool)** • **[Change Log]("
+ },
+ {
+ "kind": "relative-link",
+ "text": "./CHANGELOG.md",
+ "target": 2
+ },
+ {
+ "kind": "text",
+ "text": ")**\n\n**Read this in other languages: English | [简体中文]("
+ },
+ {
+ "kind": "relative-link",
+ "text": "./README-zh_CN.md",
+ "target": 3
+ },
+ {
+ "kind": "text",
+ "text": ")**\n\n
\n\n- [Installation](#installation)\n- [Usage](#usage)\n - [Es6 module](#es6-module)\n - [Node.js require](#nodejs-require)\n - [Using unpkg CDN](#using-unpkg-cdn)\n- [API Reference](#api-reference)\n - [Global Parameters](#global-parameters)\n - [client](#client) - The client method returns a browser result object\n - [pattern](#pattern) - Collection of common regular expressions\n - [Extras for String & Array & Object & Function](#extras-for-string--array--object--function)\n - [clearAttr](#clearattr) - Remove all attributes of HTML tags\n - [clearHtml](#clearhtml) - Removing HTML tags\n - [escape](#escape) - Escaping HTML Special Characters\n - [unescape](#unescape) - Restore HTML Special Characters\n - [getNumber](#getnumber) - Get the number in the string\n - [camel2Dash](#camel2dash) - Converts humped strings to -spaced and all lowercase Dash pattern\n - [dash2Camel](#dash2camel) - Converts -spaced and all lowercase Dash patterns to humped strings\n - [randomColor](#randomcolor) - Generate random hexadecimal colors\n - [randomNumber](#randomnumber) - Get a random number\n - [randomNumbers](#randomnumbers) - Generate n random integers that sum to a fixed sum\n - [randomString](#randomstring) - Get a random string\n - [shuffle](#shuffle) - shuffling algorithm, Reordering arrays or strings\n - [fingerprint](#fingerprint) - Generating Browser Fingerprints\n - [getCHSLength](#getchslength) - Get the length of the string, Chinese counts as 2 characters\n - [cutCHSString](#cutchsstring) - Intercept string, Chinese counts as 2 bytes\n - [upperFirst](#upperfirst) - First letter capitalized\n - [Determine](#determine)\n - [isDigitals](#isdigitals) - Determine if a string is a number\n - [isExitsFunction](#isexitsfunction) - Determine if a function is defined\n - [isExitsVariable](#isexitsvariable) - Determine if a variable is defined\n - [isEqual](#isequal) - Determine if 2 objects are equal\n - [isWindow](#iswindow) - Determine if window object\n - [isPlainObject](#isplainobject) - Determine if target is an plain object\n - [isDarkMode](#isdarkmode) - Determine if dark color mode\n - [isObject](#isobject) - Determine if target is an object\n - [isDate](#isdate) - Determine if target is Date\n - [isRegExp](#isregexp) - Determine if target is RegExp\n - [isArray](#isarray) - Determine if it is an array\n - [isIterable](#isiterable) - Determine if it is iterable\n - [inBrowser](#inbrowser) - Determine if it is running on the browser side\n - [inNodeJs](#innodejs) - Determine if it is running on node.js\n - [isNumberBrowser](#isnumberbrowser) - Detect if the client is a 360 browser\n - [windowSize](#windowsize) - Get the window size\n - [getAppVersion](#getappversion) - Get the APP version number\n - [appVersion](#appversion) - Get the app version number\n - [getOsVersion](#getosversion) - Get the phone system version\n - [osVersion](#osversion) - get the system version\n - [browserVersion](#browserversion) - Get the browser name and version\n - [compareVersion](#compareversion) - Version number size comparison, tag version: "
+ },
+ {
+ "kind": "code",
+ "text": "`rc`"
+ },
+ {
+ "kind": "text",
+ "text": " > "
+ },
+ {
+ "kind": "code",
+ "text": "`beta`"
+ },
+ {
+ "kind": "text",
+ "text": " > "
+ },
+ {
+ "kind": "code",
+ "text": "`alpha`"
+ },
+ {
+ "kind": "text",
+ "text": " > "
+ },
+ {
+ "kind": "code",
+ "text": "`other`"
+ },
+ {
+ "kind": "text",
+ "text": "\n - [parseUrlParam](#parseurlparam) - parse url params. (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)\n - [spliceUrlParam](#spliceurlparam) - Splice URL parameters (single layer only)\n - [safeParse](#safeparse) - Secure parsing of JSON strings\n - [safeStringify](#safestringify) - Secure stringify of JSON Object\n - [getDirParam](#getdirparam) - Get the URL parameter in the form of a directory\n - [getQueryParam](#getqueryparam) - Get a single query parameter (behind \"#\")\n - [getQueryParams](#getqueryparams) - Get all query parameters (behind \"#\"). (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)\n - [getUrlParam](#geturlparam) - Get a single URL parameter (from the \"location.search\", before \"#\")\n - [getUrlParams](#geturlparams) - Get all URL parameters (from the \"location.search\", before \"#\"). (If covert is passed true: Scientific notation, binary, octal and hexadecimal types of data are not converted, like: 0b111, 0o13, 0xFF, 1e3, -1e-2)\n - [localStorage & sessionStorage & Cookie](#localstorage--sessionstorage--cookie)\n - [getCache](#getcache) - Get the cache, if the deposited is Object, the retrieved is also Object, no need to convert again\n - [setCache](#setcache) - Set the cache, if the deposited is Object, the retrieved is also Object, no need to convert again\n - [delCache](#delcache) - Delete localStorage\n - [getSession](#getsession) - Get the session, if the deposited is Object, the retrieved is also Object, no need to convert again\n - [setSession](#setsession) - Set the session, if the deposited is Object, the retrieved is also Object, no need to convert again\n - [delSession](#delsession) - Delete sessionStorage\n - [getCookie](#getcookie) - Get cookie by name\n - [getCookies](#getcookies) - Get all cookies\n - [setCookie](#setcookie) - Set cookie\n - [delCookie](#delcookie) - Delete cookie\n - [Base64 & UTF8](#base64--utf8)\n - [encodeBase64](#encodebase64) - convert strings, numbers to base64\n - [decodeBase64](#decodebase64) - base64 decoding\n - [encodeUtf8](#encodeutf8) - convert strings, numbers to utf8\n - [decodeUtf8](#decodeutf8) - utf8 decoding\n - [Events](#events)\n - [stopBubble](#stopbubble) - stop bubbling\n - [stopDefault](#stopdefault) - stop default events\n - [addEvent](#addevent) - event delegate, support multiple delegates\n - [removeEvent](#removeevent) - removeEvent removes the event delegate created by addEvent\n - [getScrollPosition](#getscrollposition) - Get slide to top and bottom return 'top' 'bottom', recommend using limit flow\n - [Utilities](#utilities)\n - [nextIndex](#nextindex) - return the next zIndex value\n - [nextVersion](#nextversion) - return the next version, **Only version types with no more than 3 digits are supported**. (Follow the npm version rules)\n - [punctualTimer](#punctualtimer) - punctual setInterval\n - [promiseFactory](#promisefactory) - Convert an object to a promise like api\n - [fixNumber](#fixnumber) - truncate a few decimal places, not 0 for shortage\n - [mapTemplate](#maptemplate) - Replacing specific data in a template string, support "
+ },
+ {
+ "kind": "code",
+ "text": "`${xxxx}`"
+ },
+ {
+ "kind": "text",
+ "text": " "
+ },
+ {
+ "kind": "code",
+ "text": "`{{xxxx}}`"
+ },
+ {
+ "kind": "text",
+ "text": " and "
+ },
+ {
+ "kind": "code",
+ "text": "`{xxxx}`"
+ },
+ {
+ "kind": "text",
+ "text": "\n - [extend](#extend) - deep copy & merge objects\n - [clone](#clone) - deep copy (Buffer, Promise, Set, Map are not supported)\n - [delay](#delay) - anti-dither throttling\n - [getType](#gettype) - Get the target type\n - [getFileType](#getfiletype) - Determine file type based on link suffix\n - [sorter](#sorter) - Sorter factory function\n - [sortPinyin](#sortpinyin) - Sort Chinese by Chinese phonetic alphabet\n - [cleanData](#cleandata) - Data cleaning methods\n - [download](#download) - Several ways of file downloading\n - [searchObject](#searchobject) - tree object depth lookup\n - [openUrl](#openurl) - Open link in new tab (file jump download if browser can't parse)\n - [copy](#copy) - copy to clipboard\n - [toThousands](#tothousands) - Digital thousandths division\n - [all](#all) - return true if the provided predicate function returns true for all elements in a set, otherwise return false\n - [any](#any) - Returns true if the provided predicate function returns true for at least one element of a set, false otherwise\n - [uuid](#uuid) - generate uuid on browser side, use v4 method\n - [CSVToArray](#csvtoarray) - Converts a comma-separated string of values (CSV) to a 2D array.\n - [arrayToCSV](#arraytocsv) - Converts a two-dimensional array to a comma-separated string of values (CSV).\n - [CSVToJSON](#csvtojson) - Converts a comma-separated string of values (CSV) to an array of 2D objects. The first line of the string is used as the header line.\n - [JSONToCSV](#jsontocsv) - Converts an array of objects to a comma-separated value (CSV) string containing only the specified columns.\n - [RGBToHex](#rgbtohex) - Converts RGB component values to color codes.\n - [intersect](#intersect) - Find the intersection of multiple arrays\n - [union](#union) - Find the concatenation of multiple arrays\n - [minus](#minus) - Find the set of differences of multiple arrays that belong to A but not to B/C/D... of the elements of\n - [complement](#complement) - Find the complement of multiple arrays\n - [contains](#contains) - Whether the array contains the specified element\n - [unique](#unique) - Array de-duplication\n - [fillIPv6](#fillipv6) - ipv6 address completion\n - [getProperty](#getproperty) - Get array, object property values based on path string\n - [setProperty](#setproperty) - Set array, object property values based on path string\n - [loadSource](#loadsource) - load resources dynamically, support js, images, css links, css style strings\n - [mountCss](#mountcss) - dynamically load css link resources\n - [mountImg](#mountimg) - load image resource dynamically\n - [mountJs](#mountjs) - load js link resources dynamically\n - [mountStyle](#mountstyle) - load css styles dynamically\n - [preloader](#preloader) - Image preloading\n - [waiting](#waiting) - waiting for a while\n - [awaitTo](#awaitto) - Async await wrapper for easy error handling\n - [Blob arrayBuffer base64 file blobUrl](#blob-arraybuffer-base64-file-bloburl)\n - [arrayBufferToBase64](#arraybuffertobase64) - arrayBuffer to base64\n - [arrayBufferToBlob](#arraybuffertoblob) - arrayBuffer to blob\n - [base64ToArrayBuffer](#base64toarraybuffer) - base64 to arrayBuffer\n - [base64ToBlob](#base64toblob) - base64 to blob\n - [base64ToFile](#base64tofile) - base64 to file\n - [blobToArrayBuffer](#blobtoarraybuffer) - blob to arrayBuffer\n - [blobToBase64](#blobtobase64) - blob to base64\n - [blobToUrl](#blobtourl) - blob to url\n - [fileToBase64](#filetobase64) - file to base64\n - [svgToBlob](#svgtoblob) - svg to blob\n - [urlToBlob](#urltoblob) - url to blob\n- [Support & Issues](#support--issues)\n- [License](#license)\n\n## Installation\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```bash\n# use pnpm\npnpm install js-cool\n\n## use npm\nnpm install --save js-cool\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n## Usage\n\n### ES6 module\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```js\nimport { osVersion } from 'js-cool'\n\nosVersion()\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n### Node.js require\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```js\nconst { osVersion } = require('js-cool')\n\nosVersion()\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n### Using unpkg CDN\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```html\n\n\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n## API Reference\n\n### Global Parameters\n\n#### client\n\nThe client method returns a browser result object\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`1.0.1`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments: "
+ },
+ {
+ "kind": "code",
+ "text": "`none`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`object`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\nimport { client } from 'js-cool'\n\nclient.get(['device', 'browser', 'engine', 'os']) // { device: 'xxx', browser: 'xxx', os: 'xxx', engine: 'xxx' }\nclient.get('device') // { device: 'xxx' }\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare class Client {\n matchMap: Recordtest
')\n// 'test
'\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function clearAttr(string: string): string\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### clearHtml\n\nRemove HTML tags\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`1.0.1`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | --------------------- | -------- | -------- | -------- | ------- |\n| string | string with html tags | "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`true`"
+ },
+ {
+ "kind": "text",
+ "text": " | - |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\nclearHtml('test
string
')\n// 'teststring'\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function clearHtml(string: string): string\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### escape\n\nEscaping HTML Special Characters\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`5.5.0`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | --------------------- | -------- | -------- | -------- | ------- |\n| string | string with html tags | "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`true`"
+ },
+ {
+ "kind": "text",
+ "text": " | - |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\nescape('string
test
string
')\n// '<div>test<br />string</div>'\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function escape(string: string): string\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### unescape\n\nRestore HTML Special Characters\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`5.5.0`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | ----------- | -------- | -------- | -------- | ------- |\n| string | string | "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`true`"
+ },
+ {
+ "kind": "text",
+ "text": " | - |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\nunescape('<div>test<br />string</div>')\n// 'string
test
string
'\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function unescape(string: string): string\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### getNumber\n\nGet the number in the string\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`1.0.1`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | ------------------------------ | -------- | -------- | -------- | ------- |\n| string | pass in a string with a number | "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`true`"
+ },
+ {
+ "kind": "text",
+ "text": " | - |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ngetNumber('Chrome123.33')\n// '123.33'\n\ngetNumber('234test.88')\n// '234.88'\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function getNumber(string: string): string\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### camel2Dash\n\nConverts humped strings to -spaced and all lowercase Dash pattern\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`1.0.1`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | -------------------------- | -------- | -------- | -------- | ------- |\n| string | the string to be converted | "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`true`"
+ },
+ {
+ "kind": "text",
+ "text": " | - |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ncamel2Dash('jsCool') // js-cool\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function camel2Dash(string: string): string\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### dash2Camel\n\nConverts -spaced and all lowercase Dash patterns to humped strings\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`1.0.1`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | -------------------------- | -------- | -------- | -------- | ------- |\n| string | the string to be converted | "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`true`"
+ },
+ {
+ "kind": "text",
+ "text": " | - |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndash2Camel('js-cool') // jsCool\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function dash2Camel(string: string): string\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### randomColor\n\nGenerate random hexadecimal colors\n\n> Support for custom color value ranges starting with version 5.17.0, which can be used to customize the generation of darker, lighter, warmer colors, etc.\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`5.5.0`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | --------------------------------------- | -------------------------------------- | -------- | -------- | ------- |\n| min | the minimum value of the random numbers | "
+ },
+ {
+ "kind": "code",
+ "text": "`number`"
+ },
+ {
+ "kind": "text",
+ "text": " \\/ "
+ },
+ {
+ "kind": "code",
+ "text": "`[number, number, number]`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`false`"
+ },
+ {
+ "kind": "text",
+ "text": " | - |\n| max | the maximum value of the random numbers | "
+ },
+ {
+ "kind": "code",
+ "text": "`number`"
+ },
+ {
+ "kind": "text",
+ "text": " \\/ "
+ },
+ {
+ "kind": "code",
+ "text": "`[number, number, number]`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`false`"
+ },
+ {
+ "kind": "text",
+ "text": " | - |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`string`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\nrandomColor()\n// #bf444b\n\nrandomColor(200)\n// #d6e9d7\n\nrandomColor(200, 255)\n// #d3f9e4\n\nrandomColor([0, 0, 0], [255, 255, 255])\n// #e2f2f3\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function randomColor(\n min?: number | [number, number, number],\n max?: number | [number, number, number]\n): string\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### randomNumber\n\nGet a random number\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`5.0.0`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | -------------------------------------- | -------- | -------- | -------- | ------- |\n| min | the minimum value of the random number | "
+ },
+ {
+ "kind": "code",
+ "text": "`number`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`false`"
+ },
+ {
+ "kind": "text",
+ "text": " | 1 |\n| max | the maximum value of the random number | "
+ },
+ {
+ "kind": "code",
+ "text": "`number`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`false`"
+ },
+ {
+ "kind": "text",
+ "text": " | 10 |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`number`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Example:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\nrandomNumber() // 8\nrandomNumber(0.1, 0.9) // 0.8\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Types:\n\n"
+ },
+ {
+ "kind": "code",
+ "text": "```ts\ndeclare function randomNumber(min?: number, max?: number): number\n```"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n#### randomNumbers\n\nGenerate n random integers that sum to a fixed sum\n\n- Since: "
+ },
+ {
+ "kind": "code",
+ "text": "`5.4.0`"
+ },
+ {
+ "kind": "text",
+ "text": "\n\n- Arguments:\n\n| Parameters | Description | Type | Optional | Required | Default |\n| ---------- | ----------------------------------- | --------- | -------- | -------- | ------- |\n| n | Number of generated integers | "
+ },
+ {
+ "kind": "code",
+ "text": "`number`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`false`"
+ },
+ {
+ "kind": "text",
+ "text": " | 1 |\n| sum | Sum of generated integers | "
+ },
+ {
+ "kind": "code",
+ "text": "`number`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`false`"
+ },
+ {
+ "kind": "text",
+ "text": " | 100 |\n| noZero | Generate integers that are not zero | "
+ },
+ {
+ "kind": "code",
+ "text": "`boolean`"
+ },
+ {
+ "kind": "text",
+ "text": " | - | "
+ },
+ {
+ "kind": "code",
+ "text": "`false`"
+ },
+ {
+ "kind": "text",
+ "text": " | "
+ },
+ {
+ "kind": "code",
+ "text": "`true`"
+ },
+ {
+ "kind": "text",
+ "text": " |\n\n- Returns: "
+ },
+ {
+ "kind": "code",
+ "text": "`Arraystring
(\n promise: PromiseAll
\n): Promise<[E, undefined] | [null, P]>\n\ndeclare function awaitTo \n): Promise<[E, undefined] | [null, [T, ...P]]>\n\nexport declare type PromiseAll = {\n -readonly [K in keyof P]: Promise Collection of common regular expressions
diff --git a/types/ArrayOneMore.html b/types/ArrayOneMore.html
new file mode 100644
index 0000000..2de3303
--- /dev/null
+++ b/types/ArrayOneMore.html
@@ -0,0 +1 @@
+Type Alias AnyObject
AnyObject: Record<string, any>
diff --git a/types/ExtendData.html b/types/ExtendData.html
new file mode 100644
index 0000000..ed402e4
--- /dev/null
+++ b/types/ExtendData.html
@@ -0,0 +1 @@
+Type Alias ExtendArrayData
ExtendArrayData: any[]
diff --git a/types/ExtendObjectData.html b/types/ExtendObjectData.html
new file mode 100644
index 0000000..179bbf7
--- /dev/null
+++ b/types/ExtendObjectData.html
@@ -0,0 +1 @@
+Type Alias ExtendData
diff --git a/types/JSONValue.html b/types/JSONValue.html
new file mode 100644
index 0000000..9304120
--- /dev/null
+++ b/types/JSONValue.html
@@ -0,0 +1 @@
+Type Alias ExtendObjectData
ExtendObjectData: Record<string, any>
diff --git a/types/MaybePromiseOrGetter.html b/types/MaybePromiseOrGetter.html
new file mode 100644
index 0000000..6057b0d
--- /dev/null
+++ b/types/MaybePromiseOrGetter.html
@@ -0,0 +1 @@
+Type Alias JSONValue
diff --git a/types/OmitPartial.html b/types/OmitPartial.html
new file mode 100644
index 0000000..4c7bd32
--- /dev/null
+++ b/types/OmitPartial.html
@@ -0,0 +1 @@
+
diff --git a/types/OmitRequired.html b/types/OmitRequired.html
new file mode 100644
index 0000000..f37e833
--- /dev/null
+++ b/types/OmitRequired.html
@@ -0,0 +1 @@
+
diff --git a/types/PickPartial.html b/types/PickPartial.html
new file mode 100644
index 0000000..5006b9c
--- /dev/null
+++ b/types/PickPartial.html
@@ -0,0 +1 @@
+
diff --git a/types/PickRequired.html b/types/PickRequired.html
new file mode 100644
index 0000000..fd55d59
--- /dev/null
+++ b/types/PickRequired.html
@@ -0,0 +1 @@
+
diff --git a/types/Primitive.html b/types/Primitive.html
new file mode 100644
index 0000000..230396a
--- /dev/null
+++ b/types/Primitive.html
@@ -0,0 +1 @@
+
diff --git a/types/RandomStringCharType.html b/types/RandomStringCharType.html
new file mode 100644
index 0000000..bbef8d1
--- /dev/null
+++ b/types/RandomStringCharType.html
@@ -0,0 +1 @@
+Type Alias Primitive
Primitive: bigint | boolean | null | number | string | symbol | undefined
diff --git a/variables/default.html b/variables/default.html
new file mode 100644
index 0000000..88b025d
--- /dev/null
+++ b/variables/default.html
@@ -0,0 +1 @@
+Type Alias RandomStringCharType
RandomStringCharType: "uppercase" | "lowercase" | "number" | "special"
diff --git a/variables/inBrowser.html b/variables/inBrowser.html
new file mode 100644
index 0000000..08655b3
--- /dev/null
+++ b/variables/inBrowser.html
@@ -0,0 +1,4 @@
+Variable default
default: {
version: string;
download: (url: string, filename: string, type?: string) => void;
RGBToHex: (r: number, g: number, b: number) => string;
addEvent: typeof addEvent;
all: <T = unknown>(arr: T[], fn: AnyFunction) => boolean;
any: <T = unknown>(arr: T[], fn: AnyFunction) => boolean;
getCache: (name: string) => any;
setCache: <T = unknown>(
name: string,
value: T,
seconds?: string | number,
) => void;
delCache: (name: string) => void;
getSession: (name: string) => any;
setSession: <T = unknown>(
name: string,
value: T,
seconds?: string | number,
) => void;
delSession: (name: string) => void;
getCookie: (name: string) => any;
getCookies: () => Record<string, string>;
setCookie: <T extends string | number | boolean>(
name: string,
value: T,
seconds: string | number,
path?: string,
samesite?: boolean,
) => void;
delCookie: (name: string) => void;
camel2Dash: (string: string) => string;
cleanData: (data: any, map: any[] | AnyObject, nullFix?: any) => any;
clearAttr: (string: string) => string;
clearHtml: (string: string) => string;
escape: (string: string) => string;
unescape: (string: string) => string;
client: (
name?: string,
userAgent?: string,
) =>
| boolean
| {
IE: boolean;
GECKO: boolean;
WEBKIT: boolean;
OPERA: boolean;
TRIDENT: boolean;
MOBILE: boolean;
IOS: boolean;
ANDROID: boolean;
IPHONE: boolean;
IPAD: boolean;
QQBROWSER: boolean;
WEIXIN: boolean;
QQ: null
| RegExpMatchArray;
};
complement: <T = unknown>(...args: T[][]) => T[];
contains: (arr: any[], item: any) => boolean;
CSVToArray: (
data: string,
delimiter?: string,
omitFirstRow?: boolean,
) => string[][];
arrayToCSV: <T extends unknown[][]>(arr: T, delimiter?: string) => string;
CSVToJSON: (data: string, delimiter?: string) => any[];
JSONToCSV: (arr: any[], columns: any[], delimiter?: string) => string;
cutCHSString: (str: string, len?: number, hasDot?: boolean) => string;
dash2Camel: (string: string) => string;
decodeBase64: (input: string) => string;
decodeUtf8: (utftext: string) => string;
delay: () => {
map: any;
register(id: string, fn: AnyFunction, time: number, boo: boolean): void;
destroy(id: string): void;
};
encodeBase64: (input: string) => string;
encodeUtf8: (string: string) => string;
extend: {
(
target: ExtendObjectData,
...args: ArrayOneMore<ExtendObjectData>,
): ExtendObjectData;
(
target: boolean,
...args: ArrayOneMore<ExtendObjectData>,
): ExtendObjectData;
(
target: ExtendArrayData,
...args: ArrayOneMore<ExtendArrayData>,
): ExtendArrayData;
(target: boolean, ...args: ArrayOneMore<ExtendArrayData>): ExtendArrayData;
};
clone: <T = any>(parent: T) => T;
fillIPv6: (ip: string) => string;
fixNumber: (number: string | number, n?: number) => number;
mapTemplate: (
tmp: string,
data: Record<string, unknown> | (value: string) => unknown,
) => string;
getAppVersion: (
appName: string,
withApp?: boolean,
userAgent?: string,
) => string | boolean | null;
appVersion: {
(appName: string): string | null;
(appName: string, ua: string): string | null;
(appName: string, ua: boolean): string | null;
(appName: string, ua: string, ignoreCase: boolean): string | null;
};
getCHSLength: (str: string) => number;
getDirParam: (url: string) => DirParamType;
compareVersion: (input: string, compare: string) => -1 | 0 | 1;
getNumber: (string: string) => string;
getOsVersion: (
osName: string,
withOS?: boolean,
userAgent?: string,
) => string | boolean | null;
osVersion: (ua?: string) => OsVersion | null;
browserVersion: (ua?: string) => BrowserVersion | null;
getQueryParam: {
(key: string): string | undefined;
(key: string, url: string): string | undefined;
};
getQueryParams: {
(url: string): Record<string, string>;
(url: boolean): Record<string, unknown>;
(url: string, covert: boolean): Record<string, unknown>;
};
getProperty: {
<T extends Record<string, any>>(
target: T,
prop: string | () => string,
defaultValue?: any,
): any;
<T extends any[]>(
target: T,
prop: string | () => string,
defaultValue?: any,
): any;
};
randomColor: (
min?: number | [number, number, number],
max?: number | [number, number, number],
) => string;
randomNumber: (min?: number, max?: number) => number;
randomNumbers: (n?: number, sum?: number, noZero?: boolean) => number[];
randomString: {
(len?: number, options?: boolean | RandomStringOptions): string;
(
len?: boolean | RandomStringOptions,
options?: boolean | RandomStringOptions,
): string;
};
shuffle: {
(value: string, size?: number): string;
<T extends unknown[] = unknown[]>(value: T, size?: number): T;
};
fingerprint: (domain?: string) => null | string;
getScrollPosition: () => undefined | "bottom" | "top";
getType: <T = any>(
target: T,
) =>
| "string"
| "number"
| "bigint"
| "boolean"
| "symbol"
| "undefined"
| "object"
| "function"
| "window"
| "error"
| "promise"
| "math"
| "document"
| "navigator"
| "global"
| "array"
| "null"
| "date"
| "regexp";
getFileType: (
url: string,
) => {
suffix: string;
type:
| "audio"
| "video"
| "image"
| "other"
| "word"
| "txt"
| "excel"
| "pdf"
| "ppt"
| "zip";
};
sorter: (
locales?: string | string[],
options?: CollatorOptions,
) => <T = string, P = string>(a: T, b: P) => number;
sortPinyin: <T = string, P = string>(
a: T,
b: P,
options?: CollatorOptions,
) => number;
parseUrlParam: (url: string, covert?: boolean) => Record<string, unknown>;
spliceUrlParam: <T extends Record<string, unknown>>(
params: T,
covert?: boolean | SpliceUrlParamOptions,
) => string;
safeParse: (data: string, covert?: boolean) => any;
safeStringify: (data: any, covert?: boolean) => string;
getUrlParam: {
(key: string): string | undefined;
(key: string, url: string): string | undefined;
};
getUrlParams: {
(url: string): Record<string, string>;
(url: boolean): Record<string, unknown>;
(url: string, covert: boolean): Record<string, unknown>;
};
intersect: <T = unknown>(...args: T[][]) => T[];
isDigitals: (str: string) => boolean;
isExitsFunction: (name: string) => boolean;
isExitsVariable: (name: string) => boolean;
isEqual: <T, P>(a: T, b: P) => boolean;
isWindow: (target: any) => target is Window;
isObject: (target: any) => target is Object;
isDate: (target: any) => target is Date;
isRegExp: (target: any) => target is RegExp;
isArray: (target: any) => target is any[];
isIterable: <T = any>(target: T | Iterable<T>) => target is Iterable<T>;
isPlainObject: (target: unknown) => target is PlainObject;
isDarkMode: () => boolean;
inBrowser: boolean;
inNodeJs: boolean;
isNumberBrowser: (userAgent?: string) => boolean;
minus: <T = unknown>(...args: T[][]) => T[];
nextIndex: (min?: number, max?: number) => number;
nextVersion: (
version: string,
type?:
| "major"
| "minor"
| "patch"
| "premajor"
| "preminor"
| "prepatch"
| "prerelease",
preid?: string,
) => string;
punctualTimer: {
<TArgs extends any[]>(
handler: (args: void) => void,
delay: number,
args?: TArgs,
): PunctualTimerReturns;
<TArgs extends any[]>(
handler: (...args: TArgs) => void,
delay: number,
args?: TArgs,
): PunctualTimerReturns;
};
promiseFactory: <T extends object>(
original: T,
resolver: () => Promise<any>,
) => T & PromiseLike<T>;
waiting: (milliseconds: number, throwOnTimeout?: boolean) => Promise<void>;
awaitTo: {
<T, E = Error>(
promise: Promise<T>,
): Promise<[E, undefined] | [null, T]>;
<P extends [] | readonly unknown[], E = Error>(
promise: PromiseAll<P>,
): Promise<[E, undefined] | [null, P]>;
<T, P extends [] | readonly unknown[], E = Error>(
promise: Promise<T>,
...promises: PromiseAll<P>,
): Promise<[E, undefined] | [null, [T, ...P]]>;
};
arrayBufferToBase64: (input: ArrayBuffer, mime?: string) => string;
arrayBufferToBlob: (input: ArrayBuffer, mime?: string) => Blob;
base64ToArrayBuffer: (
input: string,
) => Uint8Array<ArrayBuffer> | Buffer<ArrayBuffer>;
base64ToBlob: (input: string) => Blob;
base64ToFile: (input: string, fileName: string) => File;
blobToArrayBuffer: (input: Blob) => Promise<ArrayBuffer | null>;
blobToBase64: (input: Blob) => Promise<string | null>;
blobToUrl: (input: Blob) => string;
fileToBase64: (input: File) => Promise<string | null>;
svgToBlob: (input: string) => Blob;
urlToBlob: (input: string) => Promise<Blob | null>;
openUrl: (url: string) => void;
copy: (value: any) => undefined | boolean;
pattern: {
any: RegExp;
number: RegExp;
string: RegExp;
postcode: RegExp;
url: RegExp;
username: RegExp;
float: RegExp;
email: RegExp;
mobile: RegExp;
chinese: RegExp;
tel: RegExp;
qq: RegExp;
pass: RegExp;
json: RegExp;
arrjson: RegExp;
array: RegExp;
isjson: RegExp;
textarea: RegExp;
mac: RegExp;
ip4: RegExp;
ip4_pri: RegExp;
};
removeEvent: (
element: AnyObject,
type: string,
handler: AnyFunction,
) => void;
searchObject: (
tree: object | any[],
expression: any,
keySet: SearchKeySet,
number?: number,
) => any[];
setProperty: (target: any, prop: string | () => string, value: any) => any;
stopBubble: (e: Event) => boolean;
stopDefault: (e: Event) => boolean;
toThousands: (num: string | number) => string;
trim: (string: string) => string;
union: <T = unknown>(...args: T[][]) => T[];
unique: <T = unknown>(arr: T[]) => T[];
upperFirst: (string: string) => string;
uuid: () => string;
windowSize: () => WindowSizeObj;
loadSource: (
url: string,
option: string | SourceOptions,
) => Promise<boolean | string>;
mountCss: (src: string, option?: CssOptions) => Promise<boolean>;
mountImg: (src: string, option?: ImgOptions) => Promise<boolean | string>;
mountJs: (src: string, option?: JsOptions) => Promise<boolean>;
mountStyle: (css: string, option?: StyleOptions) => Promise<boolean>;
preloader: {
(images: string): HTMLImageElement;
(images: string[]): Record<string, HTMLImageElement>;
};
}Type declaration
version: string
download: (url: string, filename: string, type?: string) => void
RGBToHex: (r: number, g: number, b: number) => string
addEvent: typeof addEvent
all: <T = unknown>(arr: T[], fn: AnyFunction) => boolean
any: <T = unknown>(arr: T[], fn: AnyFunction) => boolean
getCache: (name: string) => any
setCache: <T = unknown>(name: string, value: T, seconds?: string | number) => void
delCache: (name: string) => void
getSession: (name: string) => any
setSession: <T = unknown>(name: string, value: T, seconds?: string | number) => void
delSession: (name: string) => void
getCookie: (name: string) => any
getCookies: () => Record<string, string>
setCookie: <T extends string | number | boolean>(
name: string,
value: T,
seconds: string | number,
path?: string,
samesite?: boolean,
) => voiddelCookie: (name: string) => void
camel2Dash: (string: string) => string
cleanData: (data: any, map: any[] | AnyObject, nullFix?: any) => any
clearAttr: (string: string) => string
clearHtml: (string: string) => string
escape: (string: string) => string
unescape: (string: string) => string
client: (
name?: string,
userAgent?: string,
) =>
| boolean
| {
IE: boolean;
GECKO: boolean;
WEBKIT: boolean;
OPERA: boolean;
TRIDENT: boolean;
MOBILE: boolean;
IOS: boolean;
ANDROID: boolean;
IPHONE: boolean;
IPAD: boolean;
QQBROWSER: boolean;
WEIXIN: boolean;
QQ: null
| RegExpMatchArray;
}complement: <T = unknown>(...args: T[][]) => T[]
contains: (arr: any[], item: any) => boolean
CSVToArray: (data: string, delimiter?: string, omitFirstRow?: boolean) => string[][]
arrayToCSV: <T extends unknown[][]>(arr: T, delimiter?: string) => string
CSVToJSON: (data: string, delimiter?: string) => any[]
JSONToCSV: (arr: any[], columns: any[], delimiter?: string) => string
cutCHSString: (str: string, len?: number, hasDot?: boolean) => string
dash2Camel: (string: string) => string
decodeBase64: (input: string) => string
decodeUtf8: (utftext: string) => string
delay: () => {
map: any;
register(id: string, fn: AnyFunction, time: number, boo: boolean): void;
destroy(id: string): void;
}encodeBase64: (input: string) => string
encodeUtf8: (string: string) => string
extend: {
(
target: ExtendObjectData,
...args: ArrayOneMore<ExtendObjectData>,
): ExtendObjectData;
(
target: boolean,
...args: ArrayOneMore<ExtendObjectData>,
): ExtendObjectData;
(
target: ExtendArrayData,
...args: ArrayOneMore<ExtendArrayData>,
): ExtendArrayData;
(target: boolean, ...args: ArrayOneMore<ExtendArrayData>): ExtendArrayData;
}clone: <T = any>(parent: T) => T
fillIPv6: (ip: string) => string
fixNumber: (number: string | number, n?: number) => number
mapTemplate: (
tmp: string,
data: Record<string, unknown> | (value: string) => unknown,
) => stringgetAppVersion: (
appName: string,
withApp?: boolean,
userAgent?: string,
) => string | boolean | nullappVersion: {
(appName: string): string | null;
(appName: string, ua: string): string | null;
(appName: string, ua: boolean): string | null;
(appName: string, ua: string, ignoreCase: boolean): string | null;
}getCHSLength: (str: string) => number
getDirParam: (url: string) => DirParamType
compareVersion: (input: string, compare: string) => -1 | 0 | 1
getNumber: (string: string) => string
getOsVersion: (
osName: string,
withOS?: boolean,
userAgent?: string,
) => string | boolean | nullosVersion: (ua?: string) => OsVersion | null
browserVersion: (ua?: string) => BrowserVersion | null
getQueryParam: {
(key: string): string | undefined;
(key: string, url: string): string | undefined;
}getQueryParams: {
(url: string): Record<string, string>;
(url: boolean): Record<string, unknown>;
(url: string, covert: boolean): Record<string, unknown>;
}getProperty: {
<T extends Record<string, any>>(
target: T,
prop: string | () => string,
defaultValue?: any,
): any;
<T extends any[]>(
target: T,
prop: string | () => string,
defaultValue?: any,
): any;
}randomColor: (
min?: number | [number, number, number],
max?: number | [number, number, number],
) => stringrandomNumber: (min?: number, max?: number) => number
randomNumbers: (n?: number, sum?: number, noZero?: boolean) => number[]
randomString: {
(len?: number, options?: boolean | RandomStringOptions): string;
(
len?: boolean | RandomStringOptions,
options?: boolean | RandomStringOptions,
): string;
}shuffle: {
(value: string, size?: number): string;
<T extends unknown[] = unknown[]>(value: T, size?: number): T;
}fingerprint: (domain?: string) => null | string
getScrollPosition: () => undefined | "bottom" | "top"
getType: <T = any>(
target: T,
) =>
| "string"
| "number"
| "bigint"
| "boolean"
| "symbol"
| "undefined"
| "object"
| "function"
| "window"
| "error"
| "promise"
| "math"
| "document"
| "navigator"
| "global"
| "array"
| "null"
| "date"
| "regexp"getFileType: (
url: string,
) => {
suffix: string;
type:
| "audio"
| "video"
| "image"
| "other"
| "word"
| "txt"
| "excel"
| "pdf"
| "ppt"
| "zip";
}sorter: (
locales?: string | string[],
options?: CollatorOptions,
) => <T = string, P = string>(a: T, b: P) => numbersortPinyin: <T = string, P = string>(a: T, b: P, options?: CollatorOptions) => number
parseUrlParam: (url: string, covert?: boolean) => Record<string, unknown>
spliceUrlParam: <T extends Record<string, unknown>>(
params: T,
covert?: boolean | SpliceUrlParamOptions,
) => stringsafeParse: (data: string, covert?: boolean) => any
safeStringify: (data: any, covert?: boolean) => string
getUrlParam: {
(key: string): string | undefined;
(key: string, url: string): string | undefined;
}getUrlParams: {
(url: string): Record<string, string>;
(url: boolean): Record<string, unknown>;
(url: string, covert: boolean): Record<string, unknown>;
}intersect: <T = unknown>(...args: T[][]) => T[]
isDigitals: (str: string) => boolean
isExitsFunction: (name: string) => boolean
isExitsVariable: (name: string) => boolean
isEqual: <T, P>(a: T, b: P) => boolean
isWindow: (target: any) => target is Window
isObject: (target: any) => target is Object
isDate: (target: any) => target is Date
isRegExp: (target: any) => target is RegExp
isArray: (target: any) => target is any[]
isIterable: <T = any>(target: T | Iterable<T>) => target is Iterable<T>
isPlainObject: (target: unknown) => target is PlainObject
isDarkMode: () => boolean
inBrowser: boolean
inNodeJs: boolean
isNumberBrowser: (userAgent?: string) => boolean
minus: <T = unknown>(...args: T[][]) => T[]
nextIndex: (min?: number, max?: number) => number
nextVersion: (
version: string,
type?:
| "major"
| "minor"
| "patch"
| "premajor"
| "preminor"
| "prepatch"
| "prerelease",
preid?: string,
) => stringpunctualTimer: {
<TArgs extends any[]>(
handler: (args: void) => void,
delay: number,
args?: TArgs,
): PunctualTimerReturns;
<TArgs extends any[]>(
handler: (...args: TArgs) => void,
delay: number,
args?: TArgs,
): PunctualTimerReturns;
}promiseFactory: <T extends object>(
original: T,
resolver: () => Promise<any>,
) => T & PromiseLike<T>waiting: (milliseconds: number, throwOnTimeout?: boolean) => Promise<void>
awaitTo: {
<T, E = Error>(promise: Promise<T>): Promise<[E, undefined] | [null, T]>;
<P extends [] | readonly unknown[], E = Error>(
promise: PromiseAll<P>,
): Promise<[E, undefined] | [null, P]>;
<T, P extends [] | readonly unknown[], E = Error>(
promise: Promise<T>,
...promises: PromiseAll<P>,
): Promise<[E, undefined] | [null, [T, ...P]]>;
}arrayBufferToBase64: (input: ArrayBuffer, mime?: string) => string
arrayBufferToBlob: (input: ArrayBuffer, mime?: string) => Blob
base64ToArrayBuffer: (input: string) => Uint8Array<ArrayBuffer> | Buffer<ArrayBuffer>
base64ToBlob: (input: string) => Blob
base64ToFile: (input: string, fileName: string) => File
blobToArrayBuffer: (input: Blob) => Promise<ArrayBuffer | null>
blobToBase64: (input: Blob) => Promise<string | null>
blobToUrl: (input: Blob) => string
fileToBase64: (input: File) => Promise<string | null>
svgToBlob: (input: string) => Blob
urlToBlob: (input: string) => Promise<Blob | null>
openUrl: (url: string) => void
copy: (value: any) => undefined | boolean
pattern: {
any: RegExp;
number: RegExp;
string: RegExp;
postcode: RegExp;
url: RegExp;
username: RegExp;
float: RegExp;
email: RegExp;
mobile: RegExp;
chinese: RegExp;
tel: RegExp;
qq: RegExp;
pass: RegExp;
json: RegExp;
arrjson: RegExp;
array: RegExp;
isjson: RegExp;
textarea: RegExp;
mac: RegExp;
ip4: RegExp;
ip4_pri: RegExp;
}removeEvent: (element: AnyObject, type: string, handler: AnyFunction) => void
searchObject: (
tree: object | any[],
expression: any,
keySet: SearchKeySet,
number?: number,
) => any[]setProperty: (target: any, prop: string | () => string, value: any) => any
stopBubble: (e: Event) => boolean
stopDefault: (e: Event) => boolean
toThousands: (num: string | number) => string
trim: (string: string) => string
union: <T = unknown>(...args: T[][]) => T[]
unique: <T = unknown>(arr: T[]) => T[]
upperFirst: (string: string) => string
uuid: () => string
windowSize: () => WindowSizeObj
loadSource: (url: string, option: string | SourceOptions) => Promise<boolean | string>
mountCss: (src: string, option?: CssOptions) => Promise<boolean>
mountImg: (src: string, option?: ImgOptions) => Promise<boolean | string>
mountJs: (src: string, option?: JsOptions) => Promise<boolean>
mountStyle: (css: string, option?: StyleOptions) => Promise<boolean>
preloader: {
(images: string): HTMLImageElement;
(images: string[]): Record<string, HTMLImageElement>;
}
diff --git a/variables/inNodeJs.html b/variables/inNodeJs.html
new file mode 100644
index 0000000..eda6f2b
--- /dev/null
+++ b/variables/inNodeJs.html
@@ -0,0 +1,4 @@
+
diff --git a/variables/pattern.html b/variables/pattern.html
new file mode 100644
index 0000000..267bf91
--- /dev/null
+++ b/variables/pattern.html
@@ -0,0 +1,7 @@
+
diff --git a/variables/version.html b/variables/version.html
new file mode 100644
index 0000000..907ed12
--- /dev/null
+++ b/variables/version.html
@@ -0,0 +1 @@
+Variable pattern
Constpattern: {
any: RegExp;
number: RegExp;
string: RegExp;
postcode: RegExp;
url: RegExp;
username: RegExp;
float: RegExp;
email: RegExp;
mobile: RegExp;
chinese: RegExp;
tel: RegExp;
qq: RegExp;
pass: RegExp;
json: RegExp;
arrjson: RegExp;
array: RegExp;
isjson: RegExp;
textarea: RegExp;
mac: RegExp;
ip4: RegExp;
ip4_pri: RegExp;
} = ...Type declaration
Variable version
Constversion: string = ...
Converts a comma-separated string of values (CSV) to a 2D array.
+Example
+ +Since
1.0.9
+