diff --git a/api/@ohos.convertxml.d.ts b/api/@ohos.convertxml.d.ts index bf0cbe1192fa7253dd6ceae318a9644f4003172c..d77c980e64b65beba42f1c56c416f6a74aa82a5a 100644 --- a/api/@ohos.convertxml.d.ts +++ b/api/@ohos.convertxml.d.ts @@ -153,7 +153,7 @@ declare namespace xml { * @syscap SystemCapability.Utils.Lang * @param xml The xml text to be converted. * @param option Option Inputted by user to set. - * @return Returns a JavaScript object converting from XML text. + * @returns Returns a JavaScript object converting from XML text. */ convert(xml: string, options?: ConvertOptions) : Object; @@ -163,7 +163,7 @@ declare namespace xml { * @syscap SystemCapability.Utils.Lang * @param xml The xml text to be converted. * @param option Option Inputted by user to set. - * @return Returns a JavaScript object converting from XML text. + * @returns Returns a JavaScript object converting from XML text. * @throws {BusinessError} 401 - if the input parameters are invalid. * @throws {BusinessError} 10200002 - Invalid xml string. */ diff --git a/api/@ohos.process.d.ts b/api/@ohos.process.d.ts index 875e6dd2c16ba15a32be5b15a8c886f41622fb55..7da4212ef49da09e61e0ceaf8dec6daebc2896ad 100644 --- a/api/@ohos.process.d.ts +++ b/api/@ohos.process.d.ts @@ -34,7 +34,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return the pid of the current process. + * @returns Return the pid of the current process. */ readonly pid: number; @@ -43,7 +43,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return the pid of the current child process. + * @returns Return the pid of the current child process. */ readonly ppid: number; @@ -52,7 +52,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return the exit code of the current child process. + * @returns Return the exit code of the current child process. */ readonly exitCode: number; @@ -61,7 +61,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return whether the current process signal is sent successfully. + * @returns Return whether the current process signal is sent successfully. */ readonly killed: boolean; @@ -70,7 +70,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return the target process exit code. + * @returns Return the target process exit code. */ wait(): Promise; @@ -79,7 +79,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return subprocess standard outpute. + * @returns Return subprocess standard output. */ getOutput(): Promise; @@ -88,7 +88,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return subprocess standard error output. + * @returns Return subprocess standard error output. */ getErrorOutput(): Promise; @@ -123,7 +123,7 @@ declare namespace process { * @since 9 * @syscap SystemCapability.Utils.Lang * @param v An id. - * @return Return a boolean whether the specified uid belongs to a particular application. + * @returns Return a boolean whether the specified uid belongs to a particular application. * @throws {BusinessError} 401 - The type of v must be number. */ isAppUid(v: number): boolean; @@ -133,7 +133,7 @@ declare namespace process { * @since 9 * @syscap SystemCapability.Utils.Lang * @param v Process name. - * @return Return the uid based on the specified user name. + * @returns Return the uid based on the specified user name. * @throws {BusinessError} 401 - The type of v must be string. */ getUidForName(v: string): number; @@ -143,7 +143,7 @@ declare namespace process { * @since 9 * @syscap SystemCapability.Utils.Lang * @param v The tid of the process. - * @return Return the thread priority based on the specified tid. + * @returns Return the thread priority based on the specified tid. * @throws {BusinessError} 401 - The type of v must be number. */ getThreadPriority(v: number): number; @@ -153,7 +153,7 @@ declare namespace process { * @since 9 * @syscap SystemCapability.Utils.Lang * @param name Parameters defined by the system configuration. - * @return Return the system configuration at runtime. + * @returns Return the system configuration at runtime. * @throws {BusinessError} 401 - The type of name must be number. */ getSystemConfig(name: number): number; @@ -163,7 +163,7 @@ declare namespace process { * @since 9 * @syscap SystemCapability.Utils.Lang * @param name Parameters defined by the system environment variables. - * @Returns the system value for environment variables. + * @returns Return the system value for environment variables. * @throws {BusinessError} 401 - The type of name must be string. */ getEnvironmentVar(name: string): string; @@ -183,7 +183,7 @@ declare namespace process { * @syscap SystemCapability.Utils.Lang * @param signal Signal sent. * @param pid Send signal to target pid. - * @return Return the result of the signal. + * @returns Return the result of the signal. * @throws {BusinessError} 401 - if the input parameters are invalid. */ kill(signal: number, pid: number): boolean; @@ -194,7 +194,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return the numeric valid group ID of the process. + * @returns Return the numeric valid group ID of the process. */ const egid: number; @@ -203,7 +203,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return the numeric valid user identity of the process. + * @returns Return the numeric valid user identity of the process. */ const euid: number; @@ -212,7 +212,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return the numeric group if of the process. + * @returns Return the numeric group if of the process. */ const gid: number @@ -220,7 +220,7 @@ declare namespace process { * Returns the digital user id of the process * @since 7 * @syscap SystemCapability.Utils.Lang - * @return Return the digital user id of the process. + * @returns Return the digital user id of the process. */ const uid: number; @@ -229,7 +229,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return an array with supplementary group id. + * @returns Return an array with supplementary group id. */ const groups: number[]; @@ -237,7 +237,7 @@ declare namespace process { * Return pid is The pid of the current process * @since 7 * @syscap SystemCapability.Utils.Lang - * @return Return The pid of the current process. + * @returns Return The pid of the current process. */ const pid: number; @@ -246,7 +246,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return The pid of the current child process. + * @returns Return The pid of the current child process. */ const ppid: number; @@ -254,7 +254,7 @@ declare namespace process { * Returns the tid of the current thread. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Return the tid of the current thread. + * @returns Return the tid of the current thread. */ const tid: number; @@ -262,7 +262,7 @@ declare namespace process { * Returns a boolean whether the process is isolated. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Return boolean whether the process is isolated. + * @returns Return boolean whether the process is isolated. */ function isIsolatedProcess(): boolean; @@ -273,7 +273,7 @@ declare namespace process { * @useinstead ohos.process.ProcessManager.isAppUid * @syscap SystemCapability.Utils.Lang * @param v An id. - * @return Return a boolean whether the specified uid belongs to a particular application. + * @returns Return a boolean whether the specified uid belongs to a particular application. */ function isAppUid(v: number): boolean; @@ -281,7 +281,7 @@ declare namespace process { * Returns a boolean whether the process is running in a 64-bit environment. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Return a boolean whether the process is running in a 64-bit environment. + * @returns Return a boolean whether the process is running in a 64-bit environment. */ function is64Bit(): boolean; @@ -292,7 +292,7 @@ declare namespace process { * @useinstead ohos.process.ProcessManager.getUidForName * @syscap SystemCapability.Utils.Lang * @param v Process name. - * @return Return the uid based on the specified user name. + * @returns Return the uid based on the specified user name. */ function getUidForName(v: string): number; @@ -303,7 +303,7 @@ declare namespace process { * @useinstead ohos.process.ProcessManager.getThreadPriority * @syscap SystemCapability.Utils.Lang * @param v The tid of the process. - * @return Return the thread priority based on the specified tid. + * @returns Return the thread priority based on the specified tid. */ function getThreadPriority(v: number): number; @@ -311,7 +311,7 @@ declare namespace process { * Returns the elapsed real time (in milliseconds) taken from the start of the system to the start of the process. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Return the start of the system to the start of the process. + * @returns Return the start of the system to the start of the process. */ function getStartRealtime(): number; @@ -319,7 +319,7 @@ declare namespace process { * Returns the cpu time (in milliseconds) from the time when the process starts to the current time. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Return the cpu time (in milliseconds) from the time when the process starts to the current time. + * @returns Return the cpu time (in milliseconds) from the time when the process starts to the current time. */ function getPastCpuTime(): number; @@ -330,7 +330,7 @@ declare namespace process { * @useinstead ohos.process.ProcessManager.getSystemConfig * @syscap SystemCapability.Utils.Lang * @param name Parameters defined by the system configuration. - * @return Return the system configuration at runtime. + * @returns Return the system configuration at runtime. */ function getSystemConfig(name: number): number; @@ -341,13 +341,13 @@ declare namespace process { * @useinstead ohos.process.ProcessManager.getEnvironmentVar * @syscap SystemCapability.Utils.Lang * @param name Parameters defined by the system environment variables. - * @Returns the system value for environment variables. + * @returns Return the system value for environment variables. */ function getEnvironmentVar(name: string): string; type EventListener = (evt: Object) => void; /** - * Return a child process object and spawns a new ChildProcess to run the command + * Return a child process object and spawns a new ChildProcess to run the command. * @since 7 * @syscap SystemCapability.Utils.Lang * @param command String of the shell commands executed by the child process. @@ -355,7 +355,7 @@ declare namespace process { * process, killSignal is the signal sent when the child process reaches timeout, and maxBuffer is the size of the * maximum buffer area for standard input and output. * @systemapi Hide this for inner system use - * @return Return a child process object. + * @returns Return a child process object. */ function runCmd(command: string, options?: { timeout?: number, killSignal?: number | string, maxBuffer?: number }): ChildProcess; @@ -383,7 +383,7 @@ declare namespace process { * @syscap SystemCapability.Utils.Lang * @param type Remove the type of registered event. * @systemapi Hide this for inner system use - * @return Return removed result. + * @returns Return removed result. */ function off(type: string): boolean; @@ -402,7 +402,7 @@ declare namespace process { * @since 7 * @syscap SystemCapability.Utils.Lang * @systemapi Hide this for inner system use - * @return Return the current work directory. + * @returns Return the current work directory. */ function cwd(): string; @@ -419,7 +419,7 @@ declare namespace process { * Returns the running time of the system * @since 7 * @syscap SystemCapability.Utils.Lang - * @return Return the running time of the system. + * @returns Return the running time of the system. */ function uptime(): number; @@ -431,7 +431,7 @@ declare namespace process { * @syscap SystemCapability.Utils.Lang * @param signal Signal sent. * @param pid Send signal to target pid. - * @return Return the result of the signal. + * @returns Return the result of the signal. */ function kill(signal: number, pid: number): boolean; } diff --git a/api/@ohos.uri.d.ts b/api/@ohos.uri.d.ts index 7778407067e1e30e73502e61ecfecf91e9c0add9..585008714b9caa3ea95ebbeb67f8d0c55dc5cf79 100644 --- a/api/@ohos.uri.d.ts +++ b/api/@ohos.uri.d.ts @@ -40,7 +40,7 @@ declare namespace uri { * Returns the serialized URI as a string. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Returns the serialized URI as a string. + * @returns Returns the serialized URI as a string. */ toString(): string; @@ -51,7 +51,7 @@ declare namespace uri { * @useinstead ohos.uri.URI.equalsTo * @syscap SystemCapability.Utils.Lang * @param other URI object to be compared - * @return boolean Tests whether this URI is equivalent to other URI objects. + * @returns boolean Tests whether this URI is equivalent to other URI objects. */ equals(other: URI): boolean; @@ -60,7 +60,7 @@ declare namespace uri { * @since 9 * @syscap SystemCapability.Utils.Lang * @param other URI object to be compared - * @return boolean Tests whether this URI is equivalent to other URI objects. + * @returns boolean Tests whether this URI is equivalent to other URI objects. * @throws {BusinessError} 10200002 - The type of other must be URI. */ equalsTo(other: URI): boolean; @@ -69,7 +69,7 @@ declare namespace uri { * Indicates whether this URI is an absolute URI. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return boolean Indicates whether the URI is an absolute URI (whether the scheme component is defined). + * @returns boolean Indicates whether the URI is an absolute URI (whether the scheme component is defined). */ checkIsAbsolute(): boolean; @@ -77,7 +77,7 @@ declare namespace uri { * Normalize the path of this URI. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return URI Used to normalize the path of this URI and return a URI object whose path has been normalized. + * @returns URI Used to normalize the path of this URI and return a URI object whose path has been normalized. */ normalize(): URI; diff --git a/api/@ohos.url.d.ts b/api/@ohos.url.d.ts index 80d25e6c6d6dafe21bd029c13420a3873ad7bc2f..60658249a4f29a38a94dea8c245524619ed6f058 100644 --- a/api/@ohos.url.d.ts +++ b/api/@ohos.url.d.ts @@ -70,7 +70,7 @@ declare namespace url { * @useinstead ohos.url.URLParams.getAll * @syscap SystemCapability.Utils.Lang * @param name Specifies the name of a key value. - * @return string[] Returns all key-value pairs with the specified name. + * @returns string[] Returns all key-value pairs with the specified name. */ getAll(name: string): string[]; @@ -81,7 +81,7 @@ declare namespace url { * @deprecated since 9 * @useinstead ohos.url.URLParams.entries * @syscap SystemCapability.Utils.Lang - * @return Returns an iterator for ES6. + * @returns Returns an iterator for ES6. */ entries(): IterableIterator<[string, string]>; @@ -105,7 +105,7 @@ declare namespace url { * @useinstead ohos.url.URLParams.get * @syscap SystemCapability.Utils.Lang * @param name Specifies the name of a key-value pair. - * @return Returns the first value found by name. If no value is found, null is returned. + * @returns Returns the first value found by name. If no value is found, null is returned. */ get(name: string): string | null; @@ -116,7 +116,7 @@ declare namespace url { * @useinstead ohos.url.URLParams.has * @syscap SystemCapability.Utils.Lang * @param name Specifies the name of a key-value pair. - * @return Returns a Boolean value that indicates whether a found + * @returns Returns a Boolean value that indicates whether a found */ has(name: string): boolean; @@ -149,7 +149,7 @@ declare namespace url { * @deprecated since 9 * @useinstead ohos.url.URLParams.keys * @syscap SystemCapability.Utils.Lang - * @return Returns an ES6 Iterator over the names of each name-value pair. + * @returns Returns an ES6 Iterator over the names of each name-value pair. */ keys(): IterableIterator; @@ -159,7 +159,7 @@ declare namespace url { * @deprecated since 9 * @useinstead ohos.url.URLParams.values * @syscap SystemCapability.Utils.Lang - * @return Returns an ES6 Iterator over the values of each name-value pair. + * @returns Returns an ES6 Iterator over the values of each name-value pair. */ values(): IterableIterator; @@ -170,7 +170,7 @@ declare namespace url { * @deprecated since 9 * @useinstead ohos.url.URLParams.[Symbol.iterator] * @syscap SystemCapability.Utils.Lang - * @return Returns an ES6 iterator. Each item of the iterator is a JavaScript Array. + * @returns Returns an ES6 iterator. Each item of the iterator is a JavaScript Array. * The first item of Array is name, and the second item of Array is value. */ [Symbol.iterator](): IterableIterator<[string, string]>; @@ -181,7 +181,7 @@ declare namespace url { * @deprecated since 9 * @useinstead ohos.url.URLParams.toString * @syscap SystemCapability.Utils.Lang - * @return Returns a search parameter serialized as a string, percent-encoded if necessary. + * @returns Returns a search parameter serialized as a string, percent-encoded if necessary. */ toString(): string; } @@ -230,7 +230,7 @@ declare namespace url { * @since 9 * @syscap SystemCapability.Utils.Lang * @param name Specifies the name of a key value. - * @return string[] Returns all key-value pairs with the specified name. + * @returns string[] Returns all key-value pairs with the specified name. * @throws {BusinessError} 401 - The type of name must be string. */ getAll(name: string): string[]; @@ -240,7 +240,7 @@ declare namespace url { * The first item of Array is name, and the second item of Array is value. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns an iterator for ES6. + * @returns Returns an iterator for ES6. */ entries(): IterableIterator<[string, string]>; @@ -261,7 +261,7 @@ declare namespace url { * @since 9 * @syscap SystemCapability.Utils.Lang * @param name Specifies the name of a key-value pair. - * @return Returns the first value found by name. If no value is found, null is returned. + * @returns Returns the first value found by name. If no value is found, null is returned. * @throws {BusinessError} 401 - The type of name must be string. */ get(name: string): string | null; @@ -271,7 +271,7 @@ declare namespace url { * @since 9 * @syscap SystemCapability.Utils.Lang * @param name Specifies the name of a key-value pair. - * @return Returns a Boolean value that indicates whether a found + * @returns Returns a Boolean value that indicates whether a found * @throws {BusinessError} 401 - The type of name must be string. */ has(name: string): boolean; @@ -300,7 +300,7 @@ declare namespace url { * Returns an iterator allowing to go through all keys contained in this object. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns an ES6 Iterator over the names of each name-value pair. + * @returns Returns an ES6 Iterator over the names of each name-value pair. */ keys(): IterableIterator; @@ -308,7 +308,7 @@ declare namespace url { * Returns an iterator allowing to go through all values contained in this object. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns an ES6 Iterator over the values of each name-value pair. + * @returns Returns an ES6 Iterator over the values of each name-value pair. */ values(): IterableIterator; @@ -317,7 +317,7 @@ declare namespace url { * pairs contained in this object. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns an ES6 iterator. Each item of the iterator is a JavaScript Array. + * @returns Returns an ES6 iterator. Each item of the iterator is a JavaScript Array. * The first item of Array is name, and the second item of Array is value. */ [Symbol.iterator](): IterableIterator<[string, string]>; @@ -326,7 +326,7 @@ declare namespace url { * Returns a query string suitable for use in a URL. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns a search parameter serialized as a string, percent-encoded if necessary. + * @returns Returns a search parameter serialized as a string, percent-encoded if necessary. */ toString(): string; } @@ -369,7 +369,7 @@ declare namespace url { * Returns the serialized URL as a string. * @since 7 * @syscap SystemCapability.Utils.Lang - * @return Returns the serialized URL as a string. + * @returns Returns the serialized URL as a string. */ toString(): string; @@ -377,7 +377,7 @@ declare namespace url { * Returns the serialized URL as a string. * @since 7 * @syscap SystemCapability.Utils.Lang - * @return Returns the serialized URL as a string. + * @returns Returns the serialized URL as a string. */ toJSON(): string; @@ -457,9 +457,6 @@ declare namespace url { * the URL instance. To replace the entire query parameter for a URL, use url.searchsetter. * @since 7 * @syscap SystemCapability.Utils.Lang - * @note Be careful when modifying with .searchParams, because the URLSearchParams - * object uses different rules to determine which characters to - * percent-encode according to the WHATWG specification. */ readonly searchParams: URLSearchParams; diff --git a/api/@ohos.util.d.ts b/api/@ohos.util.d.ts index 71a15492b2603cdb5f9f2c4c63958bc901bdb122..a5f95ed44f06e7ca7e222be4d7d8e7e1c0abf0fd 100644 --- a/api/@ohos.util.d.ts +++ b/api/@ohos.util.d.ts @@ -44,7 +44,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param format Styled string * @param args Data to be formatted - * @return Return the character string formatted in a specific format + * @returns Return the character string formatted in a specific format */ function printf(format: string, ...args: Object[]): string; @@ -69,7 +69,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param format Styled string * @param args Data to be formatted - * @return Return the character string formatted in a specific format + * @returns Return the character string formatted in a specific format * @throws {BusinessError} 401 - if the input parameters are invalid. */ function format(format: string, ...args: Object[]): string; @@ -81,7 +81,7 @@ declare namespace util { * @useinstead ohos.util.errnoToString * @syscap SystemCapability.Utils.Lang * @param errno The error code generated by an error in the system - * @return Return the string name of a system errno + * @returns Return the string name of a system errno */ function getErrorString(errno: number): string; @@ -90,7 +90,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param errno The error code generated by an error in the system - * @return Return the string name of a system errno + * @returns Return the string name of a system errno * @throws {BusinessError} 401 - The type of errno must be number. */ function errnoToString(errno: number): string; @@ -111,7 +111,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param original Asynchronous function - * @return Return a function that returns promises + * @returns Return a function that returns promises * @throws {BusinessError} 401 - The type of original must be Function. */ function promisify(original: (err: Object, value: Object) => void): Function; @@ -124,7 +124,7 @@ declare namespace util { * @useinstead ohos.util.promisify * @syscap SystemCapability.Utils.Lang * @param original Asynchronous function - * @return Return a version that returns promises + * @returns Return a version that returns promises */ function promiseWrapper(original: (err: Object, value: Object) => void): Object; @@ -133,7 +133,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param entropyCache Whether to generate the UUID with using the cache. Default: true. - * @return Return a string representing this UUID. + * @returns Return a string representing this UUID. * @throws {BusinessError} 401 - The type of entropyCache must be boolean. */ function randomUUID(entropyCache?: boolean): string; @@ -143,7 +143,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param entropyCache Whether to generate the UUID with using the cache. Default: true. - * @return Return a Uint8Array representing this UUID. + * @returns Return a Uint8Array representing this UUID. * @throws {BusinessError} 401 - The type of entropyCache must be boolean. */ function randomBinaryUUID(entropyCache?: boolean): Uint8Array; @@ -153,7 +153,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param uuid String that specifies a UUID - * @return Return a Uint8Array representing this UUID. Throw SyntaxError if parsing fails. + * @returns Return a Uint8Array representing this UUID. Throw SyntaxError if parsing fails. * @throws {BusinessError} 401 - The type of uuid must be string. */ function parseUUID(uuid: string): Uint8Array; @@ -225,7 +225,7 @@ declare namespace util { * @useinstead ohos.util.decodeWithStream * @syscap SystemCapability.Utils.Lang * @param input Decoded numbers in accordance with the format - * @return Return decoded text + * @returns Return decoded text */ decode(input: Uint8Array, options?: { stream?: false }): string; @@ -234,7 +234,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param input Decoded numbers in accordance with the format - * @return Return decoded text + * @returns Return decoded text * @throws {BusinessError} 401 - if the input parameters are invalid. */ decodeWithStream(input: Uint8Array, options?: { stream?: boolean }): string; @@ -277,7 +277,7 @@ declare namespace util { * @useinstead ohos.util.encodeInto * @syscap SystemCapability.Utils.Lang * @param input The string to be encoded. - * @return Returns the encoded text. + * @returns Returns the encoded text. */ encode(input?: string): Uint8Array; @@ -286,7 +286,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param input The string to be encoded. - * @return Returns the encoded text. + * @returns Returns the encoded text. * @throws {BusinessError} 401 - The type of input must be string. */ encodeInto(input?: string): Uint8Array; @@ -299,7 +299,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param input The string to be encoded. * @param dest Decoded numbers in accordance with the format - * @return Returns Returns the object, where read represents + * @returns Returns Returns the object, where read represents * the number of characters that have been encoded, and written * represents the number of bytes occupied by the encoded characters. */ @@ -314,7 +314,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param input The string to be encoded. * @param dest Decoded numbers in accordance with the format - * @return Returns Returns the object, where read represents + * @returns Returns Returns the object, where read represents * the number of characters that have been encoded, and written * represents the number of bytes occupied by the encoded characters. * @throws {BusinessError} 401 - if the input parameters are invalid. @@ -364,7 +364,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param rationalString String Expression of Rational Numbers - * @return Returns a RationalNumber object generated based on the given string. + * @returns Returns a RationalNumber object generated based on the given string. * @throws {BusinessError} 401 - The type of rationalString must be string. */ static createRationalFromString(rationalString: string): RationalNumber​; @@ -376,7 +376,7 @@ declare namespace util { * @useinstead ohos.util.compare * @syscap SystemCapability.Utils.Lang * @param another An object of other rational numbers - * @return Returns 0 or 1, or -1, depending on the comparison. + * @returns Returns 0 or 1, or -1, depending on the comparison. */ compareTo(another :RationalNumber): number; @@ -385,7 +385,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param another An object of other rational numbers - * @return Returns 0 or 1, or -1, depending on the comparison. + * @returns Returns 0 or 1, or -1, depending on the comparison. * @throws {BusinessError} 401 - The type of another must be RationalNumber. */ compare(another :RationalNumber): number; @@ -395,7 +395,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param obj An object - * @return Returns true if the given object is the same as the current object; Otherwise, false is returned. + * @returns Returns true if the given object is the same as the current object; Otherwise, false is returned. */ equals(obj: Object): boolean; @@ -403,7 +403,7 @@ declare namespace util { * Gets integer and floating-point values of a rational number object. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Returns the integer and floating-point values of a rational number object. + * @returns Returns the integer and floating-point values of a rational number object. */ valueOf(): number; @@ -415,7 +415,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param number1 Is an integer. * @param number2 Is an integer. - * @return Returns the greatest common divisor of two integers, integer type. + * @returns Returns the greatest common divisor of two integers, integer type. */ static getCommonDivisor(number1: number, number2: number): number; @@ -425,7 +425,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param number1 Is an integer. * @param number2 Is an integer. - * @return Returns the greatest common divisor of two integers, integer type. + * @returns Returns the greatest common divisor of two integers, integer type. * @throws {BusinessError} 401 - if the input parameters are invalid. */ static getCommonFactor(number1: number, number2: number): number; @@ -434,7 +434,7 @@ declare namespace util { * Gets the denominator of the current object. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Returns the denominator of the current object. + * @returns Returns the denominator of the current object. */ getDenominator(): number; @@ -442,7 +442,7 @@ declare namespace util { * Gets the numerator​ of the current object. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Returns the numerator​ of the current object. + * @returns Returns the numerator​ of the current object. */ getNumerator(): number; @@ -450,7 +450,7 @@ declare namespace util { * Checks whether the current RationalNumber object represents an infinite value. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return If the denominator is not 0, true is returned. Otherwise, false is returned. + * @returns If the denominator is not 0, true is returned. Otherwise, false is returned. */ isFinite(): boolean; @@ -458,7 +458,7 @@ declare namespace util { * Checks whether the current RationalNumber object represents a Not-a-Number (NaN) value. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return If both the denominator and numerator are 0, true is returned. Otherwise, false is returned. + * @returns If both the denominator and numerator are 0, true is returned. Otherwise, false is returned. */ isNaN(): boolean; @@ -466,7 +466,7 @@ declare namespace util { * Checks whether the current RationalNumber object represents the value 0. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return If the value represented by the current object is 0, true is returned. Otherwise, false is returned. + * @returns If the value represented by the current object is 0, true is returned. Otherwise, false is returned. */ isZero(): boolean; @@ -474,7 +474,7 @@ declare namespace util { * Obtains a string representation of the current RationalNumber object. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Returns a string representation of the current RationalNumber object. + * @returns Returns a string representation of the current RationalNumber object. */ toString(): string; } @@ -513,7 +513,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.toString * @syscap SystemCapability.Utils.Lang - * @return Returns the string representation of the object and outputs the string representation of the object. + * @returns Returns the string representation of the object and outputs the string representation of the object. */ toString(): string @@ -523,7 +523,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.length * @syscap SystemCapability.Utils.Lang - * @return Returns the total number of values in the current buffer. + * @returns Returns the total number of values in the current buffer. */ length: number @@ -533,7 +533,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.getCapacity * @syscap SystemCapability.Utils.Lang - * @return Returns the capacity of the current buffer. + * @returns Returns the capacity of the current buffer. */ getCapacity(): number; @@ -552,7 +552,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.getCreateCount * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times createDefault(java.lang.Object) returned a value. + * @returns Returns the number of times createDefault(java.lang.Object) returned a value. */ getCreateCount(): number; @@ -562,7 +562,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.getMissCount * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times that the queried values are not matched. + * @returns Returns the number of times that the queried values are not matched. */ getMissCount(): number; @@ -572,7 +572,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.getRemovalCount * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times that values are evicted from the buffer. + * @returns Returns the number of times that values are evicted from the buffer. */ getRemovalCount(): number; @@ -582,7 +582,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.getMatchCount * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times that the queried values are successfully matched. + * @returns Returns the number of times that the queried values are successfully matched. */ getMatchCount(): number; @@ -592,7 +592,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.getPutCount * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times that values are added to the buffer. + * @returns Returns the number of times that values are added to the buffer. */ getPutCount(): number; @@ -602,7 +602,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.isEmpty * @syscap SystemCapability.Utils.Lang - * @return Returns true if the current buffer contains no value. + * @returns Returns true if the current buffer contains no value. */ isEmpty(): boolean; @@ -613,7 +613,7 @@ declare namespace util { * @useinstead ohos.util.LRUCache.get * @syscap SystemCapability.Utils.Lang * @param key Indicates the key to query. - * @return Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise. + * @returns Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise. */ get(key: K): V | undefined; @@ -625,7 +625,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param key Indicates the key to add. * @param value Indicates the value associated with the key to add. - * @return Returns the value associated with the added key; returns the original value if the key to add already exists. + * @returns Returns the value associated with the added key; returns the original value if the key to add already exists. */ put(key: K, value: V): V; @@ -635,7 +635,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.values * @syscap SystemCapability.Utils.Lang - * @return Returns the list of all values in the current buffer in ascending order, from the most recently accessed to least recently accessed. + * @returns Returns the list of all values in the current buffer in ascending order, from the most recently accessed to least recently accessed. */ values(): V[]; @@ -645,7 +645,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.keys * @syscap SystemCapability.Utils.Lang - * @return Returns a list of keys sorted from most recently accessed to least recently accessed. + * @returns Returns a list of keys sorted from most recently accessed to least recently accessed. */ keys(): K[]; @@ -656,7 +656,7 @@ declare namespace util { * @useinstead ohos.util.LRUCache.remove * @syscap SystemCapability.Utils.Lang * @param key Indicates the key to delete. - * @return Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist. + * @returns Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist. */ remove(key: K): V | undefined; @@ -680,7 +680,7 @@ declare namespace util { * @useinstead ohos.util.LRUCache.contains * @syscap SystemCapability.Utils.Lang * @param key Indicates the key to check. - * @return Returns true if the buffer contains the specified key. + * @returns Returns true if the buffer contains the specified key. */ contains(key: K): boolean; @@ -691,7 +691,7 @@ declare namespace util { * @useinstead ohos.util.LRUCache.createDefault * @syscap SystemCapability.Utils.Lang * @param key Indicates the missed key. - * @return Returns the value associated with the key. + * @returns Returns the value associated with the key. */ createDefault(key: K): V; @@ -701,7 +701,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.entries * @syscap SystemCapability.Utils.Lang - * @return Returns an array of key-value pairs for the enumeratable properties of the given object itself. + * @returns Returns an array of key-value pairs for the enumeratable properties of the given object itself. */ entries(): IterableIterator<[K, V]>; @@ -711,7 +711,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.LRUCache.[Symbol.iterator] * @syscap SystemCapability.Utils.Lang - * @return Returns a two - dimensional array in the form of key - value pairs. + * @returns Returns a two - dimensional array in the form of key - value pairs. */ [Symbol.iterator](): IterableIterator<[K, V]>; } @@ -743,7 +743,7 @@ declare namespace util { * Returns a string representation of the object. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the string representation of the object and outputs the string representation of the object. + * @returns Returns the string representation of the object and outputs the string representation of the object. */ toString(): string @@ -751,7 +751,7 @@ declare namespace util { * Obtains a list of all values in the current buffer. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the total number of values in the current buffer. + * @returns Returns the total number of values in the current buffer. */ length: number @@ -759,7 +759,7 @@ declare namespace util { * Obtains the capacity of the current buffer. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the capacity of the current buffer. + * @returns Returns the capacity of the current buffer. */ getCapacity(): number; @@ -774,7 +774,7 @@ declare namespace util { * Obtains the number of times createDefault(Object) returned a value. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times createDefault(java.lang.Object) returned a value. + * @returns Returns the number of times createDefault(java.lang.Object) returned a value. */ getCreateCount(): number; @@ -782,7 +782,7 @@ declare namespace util { * Obtains the number of times that the queried values are not matched. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times that the queried values are not matched. + * @returns Returns the number of times that the queried values are not matched. */ getMissCount(): number; @@ -790,7 +790,7 @@ declare namespace util { * Obtains the number of times that values are evicted from the buffer. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times that values are evicted from the buffer. + * @returns Returns the number of times that values are evicted from the buffer. */ getRemovalCount(): number; @@ -798,7 +798,7 @@ declare namespace util { * Obtains the number of times that the queried values are successfully matched. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times that the queried values are successfully matched. + * @returns Returns the number of times that the queried values are successfully matched. */ getMatchCount(): number; @@ -806,7 +806,7 @@ declare namespace util { * Obtains the number of times that values are added to the buffer. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the number of times that values are added to the buffer. + * @returns Returns the number of times that values are added to the buffer. */ getPutCount(): number; @@ -814,7 +814,7 @@ declare namespace util { * Checks whether the current buffer is empty. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns true if the current buffer contains no value. + * @returns Returns true if the current buffer contains no value. */ isEmpty(): boolean; @@ -823,7 +823,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param key Indicates the key to query. - * @return Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise. + * @returns Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise. * @throws {BusinessError} 401 - The type of key must be object. */ get(key: K): V | undefined; @@ -834,7 +834,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param key Indicates the key to add. * @param value Indicates the value associated with the key to add. - * @return Returns the value associated with the added key; returns the original value if the key to add already exists. + * @returns Returns the value associated with the added key; returns the original value if the key to add already exists. * @throws {BusinessError} 401 - if the input parameters are invalid. */ put(key: K, value: V): V; @@ -843,7 +843,7 @@ declare namespace util { * Obtains a list of all values in the current buffer. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the list of all values in the current buffer in ascending order, from the most recently accessed to least recently accessed. + * @returns Returns the list of all values in the current buffer in ascending order, from the most recently accessed to least recently accessed. */ values(): V[]; @@ -851,7 +851,7 @@ declare namespace util { * Obtains a list of keys for the values in the current buffer. * since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns a list of keys sorted from most recently accessed to least recently accessed. + * @returns Returns a list of keys sorted from most recently accessed to least recently accessed. */ keys(): K[]; @@ -860,7 +860,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param key Indicates the key to delete. - * @return Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist. + * @returns Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist. * @throws {BusinessError} 401 - The type of key must be object. */ remove(key: K): V | undefined; @@ -882,7 +882,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param key Indicates the key to check. - * @return Returns true if the buffer contains the specified key. + * @returns Returns true if the buffer contains the specified key. * @throws {BusinessError} 401 - The type of key must be object. */ contains(key: object): boolean; @@ -892,7 +892,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param key Indicates the missed key. - * @return Returns the value associated with the key. + * @returns Returns the value associated with the key. * @throws {BusinessError} 401 - The type of key must be object. */ createDefault(key: K): V; @@ -901,7 +901,7 @@ declare namespace util { * Returns an array of key-value pairs of enumeratable properties of a given object. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns an array of key-value pairs for the enumeratable properties of the given object itself. + * @returns Returns an array of key-value pairs for the enumeratable properties of the given object itself. */ entries(): IterableIterator<[K, V]>; @@ -909,7 +909,7 @@ declare namespace util { * Specifies the default iterator for an object. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns a two - dimensional array in the form of key - value pairs. + * @returns Returns a two - dimensional array in the form of key - value pairs. */ [Symbol.iterator](): IterableIterator<[K, V]>; } @@ -919,7 +919,7 @@ declare namespace util { * The comparison function is used by the scope. * @since 8 * @syscap SystemCapability.Utils.Lang - * @return Returns whether the current object is greater than or equal to the input object. + * @returns Returns whether the current object is greater than or equal to the input object. */ compareTo(other: ScopeComparable): boolean; } @@ -956,7 +956,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.ScopeHelper.toString * @syscap SystemCapability.Utils.Lang - * @return Returns a string representation of the current range object. + * @returns Returns a string representation of the current range object. */ toString(): string; @@ -967,7 +967,7 @@ declare namespace util { * @useinstead ohos.util.ScopeHelper.intersect * @syscap SystemCapability.Utils.Lang * @param range A Scope range object - * @return Returns the intersection of a given range and the current range. + * @returns Returns the intersection of a given range and the current range. */ intersect(range: Scope): Scope; @@ -979,7 +979,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param lowerObj A ScopeType value * @param upperObj A ScopeType value - * @return Returns the intersection of the current range and the range specified by the given lower and upper bounds. + * @returns Returns the intersection of the current range and the range specified by the given lower and upper bounds. */ intersect(lowerObj: ScopeType, upperObj: ScopeType): Scope; @@ -989,7 +989,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.ScopeHelper.getUpper * @syscap SystemCapability.Utils.Lang - * @return Returns the upper bound of the current range. + * @returns Returns the upper bound of the current range. */ getUpper(): ScopeType; @@ -999,7 +999,7 @@ declare namespace util { * @deprecated since 9 * @useinstead ohos.util.ScopeHelper.getLower * @syscap SystemCapability.Utils.Lang - * @return Returns the lower bound of the current range. + * @returns Returns the lower bound of the current range. */ getLower(): ScopeType; @@ -1011,7 +1011,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param lowerObj A ScopeType value * @param upperObj A ScopeType value - * @return Returns the smallest range that includes the current range and the given lower and upper bounds. + * @returns Returns the smallest range that includes the current range and the given lower and upper bounds. */ expand(lowerObj: ScopeType, upperObj: ScopeType): Scope; @@ -1022,7 +1022,7 @@ declare namespace util { * @useinstead ohos.util.ScopeHelper.expand * @syscap SystemCapability.Utils.Lang * @param range A Scope range object - * @return Returns the smallest range that includes the current range and a given range. + * @returns Returns the smallest range that includes the current range and a given range. */ expand(range: Scope): Scope; @@ -1033,7 +1033,7 @@ declare namespace util { * @useinstead ohos.util.ScopeHelper.expand * @syscap SystemCapability.Utils.Lang * @param value A ScopeType value - * @return Returns the smallest range that includes the current range and a given value. + * @returns Returns the smallest range that includes the current range and a given value. */ expand(value: ScopeType): Scope; @@ -1044,7 +1044,7 @@ declare namespace util { * @useinstead ohos.util.ScopeHelper.contains * @syscap SystemCapability.Utils.Lang * @param value A ScopeType value - * @return If the value is within the current range return true,otherwise return false. + * @returns If the value is within the current range return true,otherwise return false. */ contains(value: ScopeType): boolean; @@ -1055,7 +1055,7 @@ declare namespace util { * @useinstead ohos.util.ScopeHelper.contains * @syscap SystemCapability.Utils.Lang * @param range A Scope range - * @return If the current range is within the given range return true,otherwise return false. + * @returns If the current range is within the given range return true,otherwise return false. */ contains(range: Scope): boolean; @@ -1066,7 +1066,7 @@ declare namespace util { * @useinstead ohos.util.ScopeHelper.clamp * @syscap SystemCapability.Utils.Lang * @param value A ScopeType value - * @return Returns a ScopeType object that a given value is clamped to the current range.. + * @returns Returns a ScopeType object that a given value is clamped to the current range.. */ clamp(value: ScopeType): ScopeType; } @@ -1091,7 +1091,7 @@ declare namespace util { * Obtains a string representation of the current range. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns a string representation of the current range object. + * @returns Returns a string representation of the current range object. */ toString(): string; @@ -1100,7 +1100,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param range A Scope range object - * @return Returns the intersection of a given range and the current range. + * @returns Returns the intersection of a given range and the current range. * @throws {BusinessError} 401 - The type of range must be ScopeHelper. */ intersect(range: ScopeHelper): ScopeHelper; @@ -1111,7 +1111,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param lowerObj A ScopeType value * @param upperObj A ScopeType value - * @return Returns the intersection of the current range and the range specified by the given lower and upper bounds. + * @returns Returns the intersection of the current range and the range specified by the given lower and upper bounds. * @throws {BusinessError} 401 - if the input parameters are invalid. */ intersect(lowerObj: ScopeType, upperObj: ScopeType): ScopeHelper; @@ -1120,7 +1120,7 @@ declare namespace util { * Obtains the upper bound of the current range. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the upper bound of the current range. + * @returns Returns the upper bound of the current range. */ getUpper(): ScopeType; @@ -1128,7 +1128,7 @@ declare namespace util { * Obtains the lower bound of the current range. * @since 9 * @syscap SystemCapability.Utils.Lang - * @return Returns the lower bound of the current range. + * @returns Returns the lower bound of the current range. */ getLower(): ScopeType; @@ -1138,7 +1138,7 @@ declare namespace util { * @syscap SystemCapability.Utils.Lang * @param lowerObj A ScopeType value * @param upperObj A ScopeType value - * @return Returns the smallest range that includes the current range and the given lower and upper bounds. + * @returns Returns the smallest range that includes the current range and the given lower and upper bounds. * @throws {BusinessError} 401 - if the input parameters are invalid. */ expand(lowerObj: ScopeType, upperObj: ScopeType): ScopeHelper; @@ -1148,7 +1148,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param range A Scope range object - * @return Returns the smallest range that includes the current range and a given range. + * @returns Returns the smallest range that includes the current range and a given range. * @throws {BusinessError} 401 - The type of range must be ScopeHelper. */ expand(range: ScopeHelper): ScopeHelper; @@ -1158,7 +1158,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param value A ScopeType value - * @return Returns the smallest range that includes the current range and a given value. + * @returns Returns the smallest range that includes the current range and a given value. * @throws {BusinessError} 401 - The type of value must be object. */ expand(value: ScopeType): ScopeHelper; @@ -1168,7 +1168,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param value A ScopeType value - * @return If the value is within the current range return true,otherwise return false. + * @returns If the value is within the current range return true,otherwise return false. * @throws {BusinessError} 401 - The type of value must be object. */ contains(value: ScopeType): boolean; @@ -1178,7 +1178,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param range A Scope range - * @return If the current range is within the given range return true,otherwise return false. + * @returns If the current range is within the given range return true,otherwise return false. * @throws {BusinessError} 401 - The type of range must be ScopeHelper. */ contains(range: ScopeHelper): boolean; @@ -1188,7 +1188,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param value A ScopeType value - * @return Returns a ScopeType object that a given value is clamped to the current range. + * @returns Returns a ScopeType object that a given value is clamped to the current range. * @throws {BusinessError} 401 - The type of value must be object. */ clamp(value: ScopeType): ScopeType; @@ -1210,7 +1210,7 @@ declare namespace util { * @useinstead ohos.util.Base64Helper.constructor * @syscap SystemCapability.Utils.Lang * @param No input parameter is required. - * @return No return value. + * @returns No return value. */ constructor(); @@ -1221,7 +1221,7 @@ declare namespace util { * @useinstead ohos.util.Base64Helper.encodeSync * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value - * @return Return the encoded new Uint8Array. + * @returns Return the encoded new Uint8Array. */ encodeSync(src: Uint8Array): Uint8Array; @@ -1232,7 +1232,7 @@ declare namespace util { * @useinstead ohos.util.Base64Helper.encodeToStringSync * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value - * @return Return the encoded string. + * @returns Return the encoded string. */ encodeToStringSync(src: Uint8Array): string; @@ -1243,7 +1243,7 @@ declare namespace util { * @useinstead ohos.util.Base64Helper.decodeSync * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value or value A string value - * @return Return the decoded Uint8Array. + * @returns Return the decoded Uint8Array. */ decodeSync(src: Uint8Array | string): Uint8Array; @@ -1254,7 +1254,7 @@ declare namespace util { * @useinstead ohos.util.Base64Helper.encode * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value - * @return Return the encodes asynchronous new Uint8Array. + * @returns Return the encodes asynchronous new Uint8Array. */ encode(src: Uint8Array): Promise; @@ -1265,7 +1265,7 @@ declare namespace util { * @useinstead ohos.util.Base64Helper.encodeToString * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value - * @return Returns the encoded asynchronous string. + * @returns Returns the encoded asynchronous string. */ encodeToString(src: Uint8Array): Promise; @@ -1276,7 +1276,7 @@ declare namespace util { * @useinstead ohos.util.Base64Helper.decode * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value or value A string value - * @return Return the decoded asynchronous Uint8Array. + * @returns Return the decoded asynchronous Uint8Array. */ decode(src: Uint8Array | string): Promise; } @@ -1293,7 +1293,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param No input parameter is required. - * @return No return value. + * @returns No return value. */ constructor(); @@ -1302,7 +1302,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value - * @return Return the encoded new Uint8Array. + * @returns Return the encoded new Uint8Array. * @throws {BusinessError} 401 - The type of src must be Uint8Array. */ encodeSync(src: Uint8Array): Uint8Array; @@ -1312,7 +1312,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value - * @return Return the encoded string. + * @returns Return the encoded string. * @throws {BusinessError} 401 - The type of src must be Uint8Array. */ encodeToStringSync(src: Uint8Array): string; @@ -1322,7 +1322,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value or value A string value - * @return Return the decoded Uint8Array. + * @returns Return the decoded Uint8Array. * @throws {BusinessError} 401 - The type of src must be Uint8Array or string. */ decodeSync(src: Uint8Array | string): Uint8Array; @@ -1332,7 +1332,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value - * @return Return the encodes asynchronous new Uint8Array. + * @returns Return the encodes asynchronous new Uint8Array. * @throws {BusinessError} 401 - The type of src must be Uint8Array. */ encode(src: Uint8Array): Promise; @@ -1342,7 +1342,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value - * @return Returns the encoded asynchronous string. + * @returns Returns the encoded asynchronous string. * @throws {BusinessError} 401 - The type of src must be Uint8Array. */ encodeToString(src: Uint8Array): Promise; @@ -1353,7 +1353,7 @@ declare namespace util { * @since 9 * @syscap SystemCapability.Utils.Lang * @param src A Uint8Array value or value A string value - * @return Return the decoded asynchronous Uint8Array. + * @returns Return the decoded asynchronous Uint8Array. * @throws {BusinessError} 401 - The type of src must be Uint8Array or string. */ decode(src: Uint8Array | string): Promise; @@ -1370,7 +1370,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param No input parameter is required. - * @return No return value. + * @returns No return value. */ constructor(); /** @@ -1378,7 +1378,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A ArrayBuffer or SharedArrayBuffer value - * @Returns true if the value is a built-in ArrayBuffer or SharedArrayBuffer instance.. + * @returns Returns true if the value is a built-in ArrayBuffer or SharedArrayBuffer instance. */ isAnyArrayBuffer(value: Object): boolean; /** @@ -1386,7 +1386,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A included in the isAnyArrayBuffer value - * @return Returns true if the value is an instance of one of the ArrayBuffer views, such as typed array objects or DataView. Equivalent to ArrayBuffer.isView(). + * @returns Returns true if the value is an instance of one of the ArrayBuffer views, such as typed array objects or DataView. Equivalent to ArrayBuffer.isView(). */ isArrayBufferView(value: Object): boolean; /** @@ -1394,7 +1394,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A arguments value - * @return Returns true if the value is an arguments object. + * @returns Returns true if the value is an arguments object. */ isArgumentsObject(value: Object): boolean; /** @@ -1402,7 +1402,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A arraybuffer value - * @return Returns true if the value is a built-in ArrayBuffer instance. This does not include SharedArrayBuffer instances. Usually, it is desirable to test for both; See isAnyArrayBuffer() for that. + * @returns Returns true if the value is a built-in ArrayBuffer instance. This does not include SharedArrayBuffer instances. Usually, it is desirable to test for both; See isAnyArrayBuffer() for that. */ isArrayBuffer(value: Object): boolean; /** @@ -1410,7 +1410,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A async function value - * @return Returns true if the value is an async function. This only reports back what the JavaScript engine is seeing; in particular, the return value may not match the original source code if a transpilation tool was used. + * @returns Returns true if the value is an async function. This only reports back what the JavaScript engine is seeing; in particular, the return value may not match the original source code if a transpilation tool was used. */ isAsyncFunction(value: Object): boolean; /** @@ -1418,7 +1418,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A BigInt64Array value - * @return Returns true if the value is a BigInt64Array instance. + * @returns Returns true if the value is a BigInt64Array instance. */ isBigInt64Array(value: Object): boolean; /** @@ -1426,7 +1426,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A BigUint64Array value - * @return Returns true if the value is a BigUint64Array instance. + * @returns Returns true if the value is a BigUint64Array instance. */ isBigUint64Array(value: Object): boolean; /** @@ -1434,7 +1434,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A boolean object value - * @return Returns true if the value is a boolean object, e.g. created by new Boolean(). + * @returns Returns true if the value is a boolean object, e.g. created by new Boolean(). */ isBooleanObject(value: Object): boolean; /** @@ -1442,7 +1442,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A boxed primitive object value - * @return Returns true if the value is any boxed primitive object, e.g. created by new Boolean(), new String() or Object(Symbol()). + * @returns Returns true if the value is any boxed primitive object, e.g. created by new Boolean(), new String() or Object(Symbol()). */ isBoxedPrimitive(value: Object): boolean; /** @@ -1450,7 +1450,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A DataView value - * @return Returns true if the value is a built-in DataView instance. + * @returns Returns true if the value is a built-in DataView instance. */ isDataView(value: Object): boolean; /** @@ -1458,7 +1458,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Date value - * @return Returns true if the value is a built-in Date instance. + * @returns Returns true if the value is a built-in Date instance. */ isDate(value: Object): boolean; /** @@ -1466,7 +1466,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A External value - * @return Returns true if the value is a native External value. + * @returns Returns true if the value is a native External value. */ isExternal(value: Object): boolean; /** @@ -1474,7 +1474,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Float32Array value - * @return Returns true if the value is a built-in Float32Array instance. + * @returns Returns true if the value is a built-in Float32Array instance. */ isFloat32Array(value: Object): boolean; /** @@ -1482,7 +1482,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Float64Array value - * @return Returns true if the value is a built-in Float64Array instance. + * @returns Returns true if the value is a built-in Float64Array instance. */ isFloat64Array(value: Object): boolean; /** @@ -1490,7 +1490,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A generator function value - * @return Returns true if the value is a generator function. This only reports back what the JavaScript engine is seeing; in particular, the return value may not match the original source code if a transpilation tool was used. + * @returns Returns true if the value is a generator function. This only reports back what the JavaScript engine is seeing; in particular, the return value may not match the original source code if a transpilation tool was used. */ isGeneratorFunction(value: Object): boolean; /** @@ -1498,7 +1498,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A generator object value - * @return Returns true if the value is a generator object as returned from a built-in generator function. This only reports back what the JavaScript engine is seeing; in particular, the return value may not match the original source code if a transpilation tool was used. + * @returns Returns true if the value is a generator object as returned from a built-in generator function. This only reports back what the JavaScript engine is seeing; in particular, the return value may not match the original source code if a transpilation tool was used. */ isGeneratorObject(value: Object): boolean; /** @@ -1506,7 +1506,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Int8Array value - * @return Returns true if the value is a built-in Int8Array instance. + * @returns Returns true if the value is a built-in Int8Array instance. */ isInt8Array(value: Object): boolean; /** @@ -1514,7 +1514,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Int16Array value - * @return Returns true if the value is a built-in Int16Array instance. + * @returns Returns true if the value is a built-in Int16Array instance. */ isInt16Array(value: Object): boolean; /** @@ -1522,7 +1522,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Int32Array value - * @return Returns true if the value is a built-in Int32Array instance. + * @returns Returns true if the value is a built-in Int32Array instance. */ isInt32Array(value: Object): boolean; /** @@ -1530,7 +1530,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Map value - * @return Returns true if the value is a built-in Map instance. + * @returns Returns true if the value is a built-in Map instance. */ isMap(value: Object): boolean; /** @@ -1538,7 +1538,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Map iterator value - * @return Returns true if the value is an iterator returned for a built-in Map instance. + * @returns Returns true if the value is an iterator returned for a built-in Map instance. */ isMapIterator(value: Object): boolean; /** @@ -1546,7 +1546,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Module Namespace Object value - * @return Returns true if the value is an instance of a Module Namespace Object. + * @returns Returns true if the value is an instance of a Module Namespace Object. */ isModuleNamespaceObject(value: Object): boolean; /** @@ -1554,7 +1554,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Error value - * @return Returns true if the value is an instance of a built-in Error type. + * @returns Returns true if the value is an instance of a built-in Error type. */ isNativeError(value: Object): boolean; /** @@ -1562,7 +1562,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A number object value - * @return Returns true if the value is a number object, e.g. created by new Number(). + * @returns Returns true if the value is a number object, e.g. created by new Number(). */ isNumberObject(value: Object): boolean; /** @@ -1570,7 +1570,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Promise value - * @return Returns true if the value is a built-in Promise. + * @returns Returns true if the value is a built-in Promise. */ isPromise(value: Object): boolean; /** @@ -1578,7 +1578,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Proxy value - * @return Returns true if the value is a Proxy instance. + * @returns Returns true if the value is a Proxy instance. */ isProxy(value: Object): boolean; /** @@ -1586,7 +1586,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A regular expression object value - * @return Returns true if the value is a regular expression object. + * @returns Returns true if the value is a regular expression object. */ isRegExp(value: Object): boolean; /** @@ -1594,7 +1594,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Set instance value - * @return Returns true if the value is a built-in Set instance. + * @returns Returns true if the value is a built-in Set instance. */ isSet(value: Object): boolean; /** @@ -1602,7 +1602,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Set iterator value - * @return Returns true if the value is an iterator returned for a built-in Set instance. + * @returns Returns true if the value is an iterator returned for a built-in Set instance. */ isSetIterator(value: Object): boolean; /** @@ -1610,7 +1610,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A SharedArrayBuffer instance value - * @return Returns true if the value is a built-in SharedArrayBuffer instance. This does not include ArrayBuffer instances. Usually, it is desirable to test for both; See isAnyArrayBuffer() for that. + * @returns Returns true if the value is a built-in SharedArrayBuffer instance. This does not include ArrayBuffer instances. Usually, it is desirable to test for both; See isAnyArrayBuffer() for that. */ isSharedArrayBuffer(value: Object): boolean; /** @@ -1618,7 +1618,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A String object value - * @return Returns true if the value is a string object, e.g. created by new String(). + * @returns Returns true if the value is a string object, e.g. created by new String(). */ isStringObject(value: Object): boolean; /** @@ -1626,7 +1626,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A symbol object value - * @return Returns true if the value is a symbol object, created by calling Object() on a Symbol primitive. + * @returns Returns true if the value is a symbol object, created by calling Object() on a Symbol primitive. */ isSymbolObject(value: Object): boolean; /** @@ -1634,7 +1634,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A TypedArray instance value - * @return Returns true if the value is a built-in TypedArray instance. + * @returns Returns true if the value is a built-in TypedArray instance. */ isTypedArray(value: Object): boolean; /** @@ -1642,7 +1642,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Uint8Array value - * @return Returns true if the value is a built-in Uint8Array instance. + * @returns Returns true if the value is a built-in Uint8Array instance. */ isUint8Array(value: Object): boolean; /** @@ -1650,7 +1650,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Uint8ClampedArray value - * @return Returns true if the value is a built-in Uint8ClampedArray instance. + * @returns Returns true if the value is a built-in Uint8ClampedArray instance. */ isUint8ClampedArray(value: Object): boolean; /** @@ -1658,7 +1658,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Uint16Array value - * @return Returns true if the value is a built-in Uint16Array instance. + * @returns Returns true if the value is a built-in Uint16Array instance. */ isUint16Array(value: Object): boolean; /** @@ -1666,7 +1666,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A Uint32Array value - * @return Returns true if the value is a built-in Uint32Array instance. + * @returns Returns true if the value is a built-in Uint32Array instance. */ isUint32Array(value: Object): boolean; /** @@ -1674,7 +1674,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A WeakMap value - * @return Returns true if the value is a built-in WeakMap instance. + * @returns Returns true if the value is a built-in WeakMap instance. */ isWeakMap(value: Object): boolean; /** @@ -1682,7 +1682,7 @@ declare namespace util { * @since 8 * @syscap SystemCapability.Utils.Lang * @param value A WeakSet value - * @return Returns true if the value is a built-in WeakSet instance. + * @returns Returns true if the value is a built-in WeakSet instance. */ isWeakSet(value: Object): boolean; } diff --git a/api/@ohos.xml.d.ts b/api/@ohos.xml.d.ts index 49916703c67d0e1acd46ef7f612628b07df34c59..3eb9f401b1dfdc1143f61628ebf073128b0b871c 100644 --- a/api/@ohos.xml.d.ts +++ b/api/@ohos.xml.d.ts @@ -32,7 +32,7 @@ declare namespace xml { /** * A parameterized constructor used to create a new XmlSerializer instance. * As the input parameter of the constructor function, init supports three types. - * The input parameter is an Arrarybuff. + * The input parameter is an Arrarybuffer. * The input parameter is a DataView. * The input parameter is an encoding format of string type. * @throws {BusinessError} 401 - if the input parameters are invalid. @@ -67,7 +67,7 @@ declare namespace xml { setDeclaration(): void; /** - * Writes a elemnet start tag with the given name. + * Writes a element start tag with the given name. * @since 8 * @syscap SystemCapability.Utils.Lang * @param name Name of the element. @@ -285,7 +285,7 @@ declare namespace xml { * @syscap SystemCapability.Utils.Lang * @param name The current tag name. * @param value The current tag value. - * @return Returns a Boolean variable for whether parse continually. + * @returns Returns a Boolean variable for whether parse continually. */ tagValueCallbackFunction?: (name: string, value: string) => boolean; @@ -295,7 +295,7 @@ declare namespace xml { * @syscap SystemCapability.Utils.Lang * @param name The current attribute name. * @param value The current attribute value. - * @return Returns a Boolean variable for whether parse continually. + * @returns Returns a Boolean variable for whether parse continually. */ attributeValueCallbackFunction?: (name: string, value: string) => boolean; @@ -305,7 +305,7 @@ declare namespace xml { * @syscap SystemCapability.Utils.Lang * @param eventType The current token eventtype. * @param value The current token parseinfo. - * @return Returns a Boolean variable for whether parse continually. + * @returns Returns a Boolean variable for whether parse continually. */ tokenValueCallbackFunction?: (eventType: EventType, value: ParseInfo) => boolean; }