mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-23 07:10:52 +00:00
commonlibrary api doc add "@type"
issue:https://gitee.com/openharmony/interface_sdk-js/issues/IAI39P Signed-off-by: Chongwei Su <suchongwei@huawei.com>
This commit is contained in:
Chongwei Su
parent
7ae2b2382e
commit
fd2c4ebb5c
10
api/@ohos.buffer.d.ts
vendored
10
api/@ohos.buffer.d.ts
vendored
@ -724,6 +724,7 @@ declare namespace buffer {
|
||||
/**
|
||||
* Returns the number of bytes in buf
|
||||
*
|
||||
* @type { number }
|
||||
* @throws { BusinessError } 10200013 - Length cannot be set for the buffer that has only a getter.
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 9
|
||||
@ -731,6 +732,7 @@ declare namespace buffer {
|
||||
/**
|
||||
* Returns the number of bytes in buf
|
||||
*
|
||||
* @type { number }
|
||||
* @throws { BusinessError } 10200013 - Length cannot be set for the buffer that has only a getter.
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
@ -751,6 +753,7 @@ declare namespace buffer {
|
||||
/**
|
||||
* The underlying ArrayBuffer object based on which this Buffer object is created.
|
||||
*
|
||||
* @type { ArrayBuffer }
|
||||
* @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter.
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 9
|
||||
@ -758,6 +761,7 @@ declare namespace buffer {
|
||||
/**
|
||||
* The underlying ArrayBuffer object based on which this Buffer object is created.
|
||||
*
|
||||
* @type { ArrayBuffer }
|
||||
* @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter.
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
@ -778,6 +782,7 @@ declare namespace buffer {
|
||||
/**
|
||||
* The byteOffset of the Buffers underlying ArrayBuffer object
|
||||
*
|
||||
* @type { number }
|
||||
* @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter.
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 9
|
||||
@ -785,6 +790,7 @@ declare namespace buffer {
|
||||
/**
|
||||
* The byteOffset of the Buffers underlying ArrayBuffer object
|
||||
*
|
||||
* @type { number }
|
||||
* @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter.
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
@ -3377,12 +3383,14 @@ declare namespace buffer {
|
||||
/**
|
||||
* The total size of the Blob in bytes
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* The total size of the Blob in bytes
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -3401,12 +3409,14 @@ declare namespace buffer {
|
||||
/**
|
||||
* The content-type of the Blob
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* The content-type of the Blob
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
|
||||
38
api/@ohos.convertxml.d.ts
vendored
38
api/@ohos.convertxml.d.ts
vendored
@ -71,12 +71,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Whether to trim whitespace characters that may exist before and after the text, default false.
|
||||
*
|
||||
* @type { boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Whether to trim whitespace characters that may exist before and after the text, default false.
|
||||
*
|
||||
* @type { boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -94,12 +96,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Whether to ignore writing declaration directives of xml.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Whether to ignore writing declaration directives of xml.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -117,12 +121,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Whether to ignore writing processing instruction of xml.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Whether to ignore writing processing instruction of xml.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -140,12 +146,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Whether to print attributes across multiple lines and indent them.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Whether to print attributes across multiple lines and indent them.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -163,12 +171,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Whether to ignore writing comments of the elements.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Whether to ignore writing comments of the elements.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -186,12 +196,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Whether to ignore writing CDATA of the elements.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Whether to ignore writing CDATA of the elements.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -209,12 +221,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Whether to ignore writing Doctype of the elements.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Whether to ignore writing Doctype of the elements.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -232,12 +246,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Whether to ignore writing texts of the elements.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Whether to ignore writing texts of the elements.
|
||||
*
|
||||
* @type { ?boolean }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -255,12 +271,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the declaration.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the declaration.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -278,12 +296,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the processing instruction.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the processing instruction.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -301,12 +321,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the attributes.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the attributes.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -324,12 +346,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the text.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the text.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -347,12 +371,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the cdata.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the cdata.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -370,12 +396,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the doctype.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the doctype.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -393,12 +421,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the comment.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the comment.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -416,12 +446,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the parent.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the parent.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -439,12 +471,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the type.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the type.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -462,12 +496,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the name.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the name.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -485,12 +521,14 @@ declare namespace xml {
|
||||
/**
|
||||
* Name of the property key which will be used for the elements.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Name of the property key which will be used for the elements.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
|
||||
2
api/@ohos.taskpool.d.ts
vendored
2
api/@ohos.taskpool.d.ts
vendored
@ -459,12 +459,14 @@ declare namespace taskpool {
|
||||
/**
|
||||
* Concurrent function to execute in taskpool.
|
||||
*
|
||||
* @type { Function }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Concurrent function to execute in taskpool.
|
||||
*
|
||||
* @type { Function }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
|
||||
25
api/@ohos.uri.d.ts
vendored
25
api/@ohos.uri.d.ts
vendored
@ -414,12 +414,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the protocol part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Gets the protocol part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -427,6 +429,7 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the protocol part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -446,12 +449,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Obtains the user information part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Obtains the user information part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -459,6 +464,7 @@ declare namespace uri {
|
||||
/**
|
||||
* Obtains the user information part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -478,12 +484,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the hostname portion of the URI without a port.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Gets the hostname portion of the URI without a port.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -502,12 +510,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the port portion of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Gets the port portion of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -526,12 +536,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the path portion of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Gets the path portion of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -539,6 +551,7 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the path portion of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -558,12 +571,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the query portion of the URI
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Gets the query portion of the URI
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -571,6 +586,7 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the query portion of the URI
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -590,12 +606,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the fragment part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Gets the fragment part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -603,6 +621,7 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the fragment part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -622,12 +641,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the decoding permission component part of this URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Gets the decoding permission component part of this URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -635,6 +656,7 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the decoding permission component part of this URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
@ -654,12 +676,14 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the decoding scheme-specific part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 8
|
||||
*/
|
||||
/**
|
||||
* Gets the decoding scheme-specific part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -667,6 +691,7 @@ declare namespace uri {
|
||||
/**
|
||||
* Gets the decoding scheme-specific part of the URI.
|
||||
*
|
||||
* @type { string }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
|
||||
3
api/@ohos.util.d.ts
vendored
3
api/@ohos.util.d.ts
vendored
@ -1768,12 +1768,14 @@ declare namespace util {
|
||||
/**
|
||||
* Obtains a list of all values in the current buffer.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @since 9
|
||||
*/
|
||||
/**
|
||||
* Obtains a list of all values in the current buffer.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @since 10
|
||||
@ -1781,6 +1783,7 @@ declare namespace util {
|
||||
/**
|
||||
* Obtains a list of all values in the current buffer.
|
||||
*
|
||||
* @type { number }
|
||||
* @syscap SystemCapability.Utils.Lang
|
||||
* @crossplatform
|
||||
* @atomicservice
|
||||
|
||||
Loading…
Reference in New Issue
Block a user