Modify d.ts in xml and process

Signed-off-by: bi-hu <bihu@huawei.com>
https://gitee.com/openharmony/interface_sdk-js/issues/I61RLA
This commit is contained in:
bi-hu 2022-11-17 19:58:57 +08:00
parent 657638edce
commit 3ca318a2d3
6 changed files with 207 additions and 210 deletions

View File

@ -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.
*/

View File

@ -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<number>;
@ -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<Uint8Array>;
@ -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<Uint8Array>;
@ -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;
}

10
api/@ohos.uri.d.ts vendored
View File

@ -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;

39
api/@ohos.url.d.ts vendored
View File

@ -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<string>;
@ -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<string>;
@ -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<string>;
@ -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<string>;
@ -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;

282
api/@ohos.util.d.ts vendored

File diff suppressed because it is too large Load Diff

10
api/@ohos.xml.d.ts vendored
View File

@ -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;
}